Open Banking API
The Open Banking API provides secure endpoints to share financial data and services with third parties. This API offers quick and reliable user verification.…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Open Banking API provides secure endpoints to share financial data and services with third parties. This API offers quick and reliable user verification.
With these endpoints, you can:
- Create a list of available account verification routes: Create a list of Account Information Service Providers (AISPs) for third-party individual account verification. Successful connections generate a unique code used for requesting bank reports and verifying identity.
- Verify bank account ownership: Get the account verification report using the unique code from a successful open banking connection. This report provides identity verification and bank account details.
Authentication
Each request made to the Open Banking API must be signed with an API key. Generate an API key in your Customer Area.
To connect to the API, add an X-API-Keyheader with the API key as the value, for example:
curl
-H "Content-Type: application/json"
-H "X-API-Key: YOUR_API_KEY"
...Roles and permissions
To use the Open Banking API, your API credential must have the following roles:
- Role for OpenBanking account verification use case: EXTERNAL
Reach out to your Adyen contact to set up these roles.
Endpoints 2
Account Verification
- GETGet account verification report
/accountVerification/reports/:codeGet the account verification report using a unique code from a successful open banking connection. This report provides identity verification and bank account… - POSTCreate routes for account verification
/accountVerification/routesCreate a list of routes for verifying bank accounts of third-party individuals. Successful connections generate a unique code used for requesting bank reports…
API details
- Base URL
https://obgateway-test.adyen.com/obgateway/v1https://obgateway-live.adyen.com/obgateway/v1- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 2 operations on 2 pathsGET 1POST 1
- Main resources
- Account Verification 2
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Open Banking API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Open Banking API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get account verification report” (GET /accountVerification/reports/:code), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Open Banking API?
The Open Banking API provides secure endpoints to share financial data and services with third parties. This API offers quick and reliable user verification.… It is listed under Payments and has 2 endpoints.
Who publishes the Open Banking API?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Open Banking API?
Its description lists 2 base URLs: https://obgateway-test.adyen.com/obgateway/v1, https://obgateway-live.adyen.com/obgateway/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Open Banking API?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the Open Banking API have?
2 operations on 2 paths (1 GET, 1 POST). The largest groups are Account Verification.
Is forking the Open Banking API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.