Adyen Configuration
The Configuration API allows you to manage your balance platform where you can create account holders, balance accounts, cards, and business accounts.
Authentication
Each request to the Configuration API must be signed with an API key. Generate an API key in your Customer Area if you have a platform setup or marketplace setup.
If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area.
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" \
...
Versioning
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.
For example:
https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders
Going live
When going live, generate an API key in your live Customer Area if you have an Adyen for Platforms integration or live Balance Platform Customer Area if you have an Adyen Issuing integration.You can then use the API key to send requests to https://balanceplatform-api-live.adyen.com/bcl/v2.
Operations
Get all balance accounts of an account holder
Get all transaction rules for an account holder
Get all sweeps for a balance account
Get payment instruments linked to a balance account
Get all transaction rules for a balance account
Approve pending transfer limits
Get all current transfer limits
Filter and view the transfer limits
Delete a scheduled or pending transfer limit
Get the details of a transfer limit
Get all balance webhook settings
Create a balance webhook setting
Delete a balance webhook setting by id
Get a balance webhook setting by id
Update a balance webhook setting by id
Get all account holders under a balance platform
Get all transaction rules for a balance platform
Filter and view the transfer limits
Delete a scheduled or pending transfer limit
Get the details of a transfer limit
Get a list of card orders
Get a payment instrument group
Get all transaction rules for a payment instrument group
Create a payment instrument group
Get network token activation data
Create network token provisioning data
Update a payment instrument
Get the PAN of a payment instrument
Get all transaction rules for a payment instrument
Delete the authorized users for a card.
Get authorized users for a card.
Update the authorized users for a card.
Create authorized users for a card.
Create a payment instrument
Reveal the data of a payment instrument
Complete an association between an SCA device and a resource
Initiate an association between an SCA device and a resource
Get a list of registered SCA devices
Delete a registration of an SCA device
Complete the registration of an SCA device
Initiate the registration of an SCA device
Delete association to devices
Get a list of devices associated with an entity
Approve a pending approval association
Finish registration process for a SCA device
Create a new SCA association for a device
Begin SCA device registration
Create a transaction rule
Delete a transaction rule
Update a transaction rule
Calculate transfer routes
