Configuration API

https://balanceplatform-api-test.adyen.com/bcl/v2
Click to copy

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.

Authentication

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" \
...

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, 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 https://balanceplatform-api-live.adyen.com/bcl/v2.

Create an account holder
Get an account holder
Update an account holder
Get all balance accounts of an account holder
Create a balance account
Get all sweeps for a balance account
Get a balance account
Update a balance account
Get payment instruments linked to a balance account
Get a balance platform
Get all account holders under a balance platform
Get a list of card orders
Get card order items
Get a grant account
Get all available grant offers
Get a grant offer
Get a network token
Update a network token
Create a payment instrument group
Get a payment instrument group
Get all transaction rules for a payment instrument group
Create a payment instrument
Reveal the data of a payment instrument
Get a payment instrument
Update a payment instrument
Get the PAN of a payment instrument
Get all transaction rules for a payment instrument
Change a card PIN
Reveal a card PIN
Get an RSA public key
Create a transaction rule
Get a transaction rule
Delete a transaction rule
Update a transaction rule
Calculate transfer routes
Validate a bank account