crewmanmud / read-write-api-docs-pub

Open Banking Read-Write API

The Read/Write Data API specification describes a collection of RESTful APIs that enable TPPs to access information and initiate payments for customers, by connecting to ASPSPs – securely, efficiently, and with customer consent.

The specification is structured as a series of profiles, resources and data models. The structure is intended to give ASPSPs a suite of functionality to meet their regulatory and commercial requirements. ASPSPs implementing aspects of the specification should select a version of the R/W Data API Profile, compatible functional profiles (such as Accounts and Transactions or Payments) and compatible resources.

Details of version compatibility can be found in profiles section and specific sub-sections of resources and data models section of the specification.

This specification should be read in conjunction with the Customer Experience Guidelines, Operational Guidelines and Management Information Requirements. Together these form the OBIE standard, which should enable any ASPSP which implements the specification to meet their obligations under both the CMA Order and PSD2/RTS.

The key difference between the CMA Order and PSD2/RTS requirements relate to which product types are implemented, and the timing for implementation. For example, the CMA Order requires the CMA9 to implement the standard for PCA and BCA accounts earlier (in some cases) than the PSD2/RTS timelines. The timings are defined in the Open Banking Roadmap (https://www.openbanking.org.uk/wp-content/uploads/Open-Banking-Revised-Roadmap-July-2018.pdf).

Known Issues

The specification must be read in conjunction with the Known Issues.

Swagger Specification

The Swagger Specification for R/W APIs can be downloaded from the following GitHub Repository:

https://github.com/OpenBankingUK/read-write-api-specs

Change Log

Version 3.1.4

• Decision 201 - Support for High Cost Credit (HCC) requirements View Diff
  • Clarify that Credit Line should NOT be included in AvailableBalance
• Decision 203 - Changes to Dynamic Client Registration due to CIBA View Diff
• Decision 204 - Changes to CIBA profile View Diff
• Decision 205 - Aggregated Polling (Miscelleneous) View Diff
  • Scope for Event notifications
    • Changed scope for event-notifications API to be either of accounts or fundsconfirmations
  • Optionality of PUT requests
    • Changed the optionality of PUT /callback-urls
  • Optionality of DELETE requests
    • Changed the optionality of DELETE /callback-urls
• Decision 206 - Optionality of acknowledgements for aggregated polling View Diff
  • Clarified behaviour that is expected when ASPSPs do not want to process acknowledgements for aggregated polling
• Add a Change Log
  • Added a Change Log with commit links to be able to view differences between versions

  The diff links below are experimental for this draft and may function correctly Feedback on their utility is welcome.

• Implement changes for Waiver 7 View Diff
  • Removed the requirement for the b64 claim in signatures
• Fix Known Issues View Diff
• Housekeeping - Fix markdown errors and file naming View Diff
• DCR 3.1 (Migrate from Confluence) View Diff