tiongks / read-write-api-specs

Read/Write API Specifications

Read/Write Data API Specification

Overview

This is the Open Banking API specifications repository.

Releases

API specifications are tagged according to the revision they match e.g. the v3.1.7 revision be tagged as v3.1.7. 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.1.7

Specifications in OpenAPI formats

This space contains Read/Write Data API Specifications in OpenAPI format.

Account Information

• Swagger (OpenAPI 2.0) - YAML
• Swagger (OpenAPI 2.0) - JSON
• OpenAPI 3.0 - YAML
• OpenAPI 3.0 - JSON

Payment Initiation

• Swagger (OpenAPI 2.0) - YAML
• Swagger (OpenAPI 2.0) - JSON
• OpenAPI 3.0 - YAML
• OpenAPI 3.0 - JSON

Confirmation of Funds

• Swagger (OpenAPI 2.0) - YAML
• Swagger (OpenAPI 2.0) - JSON
• OpenAPI 3.0 - YAML
• OpenAPI 3.0 - JSON

Events API

• Swagger (OpenAPI 2.0) - YAML
• Swagger (OpenAPI 2.0) - JSON
• OpenAPI 3.0 - YAML
• OpenAPI 3.0 - JSON

Event Notifications API (TPP Endpoint sample)

• Swagger (OpenAPI 2.0) - YAML
• Swagger (OpenAPI 2.0) - JSON
• OpenAPI 3.0 - YAML
• OpenAPI 3.0 - JSON

The currently published OpenAPI 3.0 files are results of automatic conversions from the 2.0 formats. These conversions produce verbose output where some object references are resolved and copied to their respective endpoints. Although these files are logicaly identical to their 2.0 counterparts, they are to be replaced by sanitised versions to improve their readability.