The following APIs are available in our production environment

API

Version

PTSB Dynamic Client Registration V1.0
Account and Transactions Open Banking UK v3.1

Register You Application

To get started with our APIs you will need to register your application using the Dynamic Client Register API and be provided with OAuth 2.0 client credentials. 

 PTSB Dynamic Client Registration API Guide PDF

Production Technical Information 

Please find below key information in relation to our production environment.

 

Endpoints

x-fapi-financial-id

The PTSB OBIE Financial ID is 0015800001ZEZ3yAAH

x-fapi-interaction-id

It is optional to provide an x-fapi-interaction-id, however we recommend passing a globally unique x-fapi-interaction-id header to be used as a correlation ID. If no x-fapi-interaction-id header is passed, an ID will be generated by us and returned in our response.

OAuth

We have developed our Security Profile in line the Open Banking Standards, detailed information including specifications is available on UK Open Bank Security Profile.

  • PTSB are implementing OAuth2.0 “Hybrid flow” as specified by the Open Banking Standards
  • Client Credentials Grant Access Token is valid for 60 minutes
  • Authorisation Grant Access Token is valid for 90 days

Message Signing

We support PS256 and ES256 algorithms for TPP message signing

 

API Functional Implementation Guidelines

Please find below API functional implementation guidelines.

API

Version

Guide

Account and Transactions Open Banking UK v3.1 AISP functional implementation guide

 

Note: We currently only support SCA redirect for following AISP requests (unless an exemption applies).

  • Account Access Consents
  • Balances
  • Transactions

 

We are planning to introduce SCA redirect for remainder of the data requests in near future and AISPs will be notified in advance of the change.

Terms of Use

Please read our Terms of Use (pdf, 156KB) before accessing our production APIs.

API Technical Specifications

For further information about our APIs including the API Swagger definitions please enrol on the Developer Portal. The Account and Transactions, Payment Initiation and Confirmation of Funds APIs are developed in line with the with the Open Banking Standards. The production versions of the Payment Initiation and the Confirmation of Funds APIs will be coming soon.

Sandbox

Please use our Sandbox to test your application’s integration with our suite of API in advance of using the production environment.

TPP Enrolment Form

Use our TPP enrolment Form to request access to our developer portal.

Terms of Use

Please read our Terms of Use before you enrol on the developer portal and use the test sandbox.

Data Privacy Statement

Please read our Data Privacy Statement before you enrol on the developer portal and use the test sandbox.

Back to top
Page loading

Alternate Text