
Getting started
1
Sign Up
Found an API? Sign up now to create an account and get started. It is free to join.
2
Register an application
Register your application to obtain credentials for accessing Open Banking APIs securely
3
Explore Our APIs
Take a look at our APIs to see what choices are available. Is there an API you can exploit in one of your applications? Use the supplied APIs to quickly construct a fully featured application.
4
Conceptual Guide
A high-level overview of the key concepts, architecture, and workflows in Open Banking
5
Developer Guide
Step 1: Login or Registration
- The third-party (trusted partner) will access the Open Banking API Portal.
- If they already have an account, they can log in directly.
- If not, they will need to register by clicking the "Register" button to create an account.
Step 2: Get Credentials
- After logging in:
- The developer (trusted partner) will create an application within the portal.
- Application credentials, such as Consumer Key and Secret Key, will be generated.
- These credentials will be required for API authentication.
Step 3: Token API
- The developer navigates to the API Explorer section.
- There are two categories:
- AISP (Account Information Service Provider)
- PISP (Payment Initiation Service Provider)
- To access any other API, the developer first executes the Token API to obtain an access token.
Process for Token API: - Select AISP or PISP from the available categories.
- Click on "Authorize". A form will appear where the developer provides the Consumer Key and Secret Key.
- After submitting, the API returns the Access Token, which is needed to access further APIs.
Step 4: Create Consent API
- The developer accesses the Consent API:
- For AISP: Account Access Consent API
- For PISP: Domestic Payment Consent API
- The developer must include the Access Token in the request header.
- Upon successful execution:
- A Consent ID (Intent ID) will be generated.
- In the Consent Management system, the consent will be marked as "Awaiting Authorization".
Step 5: Authorize API
- The developer executes the Authorize API.
- Provide the necessary payload as shown in the API examples.
- Upon successful execution:
- The consent status will change to "Authorized".
Step 6: Token Exchange API
- The developer uses the Authorization Code received from the previous step.
- By executing the Token Exchange API:
- A new Access Token is issued.
- This token will encode the Consent ID (Intent ID), allowing secure access to APIs.
Step 7: AISP and PISP Service APIs
- To access the actual Open Banking APIs (AISP or PISP), the developer:
- Includes the Bearer Token (received in the Token Exchange step) in the request header.
- The Consent Management system validates the request:
- Checks if the consent is still valid, not expired, and exists.
- Once validated, the trusted partner can successfully retrieve data from the bank's Core Banking Services through the APIs.