Sing Up
Register an application
Explore Our APIs
Conceptual Guide
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
Login or Registration
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)
- AISP (Account Information Service Provider)
- TTo 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:
- There are two categories:
- 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
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
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.