The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.
Your Adyen contact will provide your API credential and an API key. To connect to the API, add an
X-API-Key header with the API key as the value, for example:
curl -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ ...
Alternatively, you can use the username and password to connect to the API using basic authentication. For example:
curl -H "Content-Type: application/json" \ -U "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \ ...
The Configuration API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: “vXX”, where XX is the version number.
When going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to
Use this page to mock Configuration API in your testing and development.
Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Configuration API, which will allow you to keep building and testing even if the actual API you isn't currently available.