README.md

Read/Write Data API Specification

Overview

This is the Open Banking API specifications repository.

Releases

API specifications will be tagged according to the revision they match e.g. the first version will be v3.0-RC3. This tag will form a Release. To retrieve the files for a given release be sure to use the appropriate URL, e.g.:

https://github.com/OpenBankingUK/open-banking-specs/releases/tag/v3.0-RC3

APIs

There are two ways to access this collection API Specifications.

The files for each specification, are grouped into format specific folders, that means as a consumer, if you are always interested in consuming OpenApi format only, then you can find all specifications in one directory dist/openapi and ignore orthers, similarly dist/swagger etc.

Alternatively following table provides another view, which lists OBIE R/W functional API resources, and the corrresponding files in different formats.

API	Formats
Account Information	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Payment Initiation	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Confirmation of Funds	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Events API (Combines Events Subscriptions and Polling)	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Event Subscription* (use events instead)	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Aggregated Polling* (use events instead)	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Callback-urls* (use events instead)	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML
Event Notifications API (TPP Endpoint sample)	- Open API - Flattened JSON - Open API - JSON - Open API - YAML - Swagger - Flattened JSON - Swagger - JSON - Swagger - YAML

* represents deprecated resources - maintained only for the backward compatibility reasons. Shall be dropped in the next minor/major version update.