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.

post /accountHolders
Create an account holder
get /accountHolders/{id}
Get an account holder
patch /accountHolders/{id}
Update an account holder
get /accountHolders/{id}/balanceAccounts
Get all balance accounts of an account holder
post /balanceAccounts
Create a balance account
get /balanceAccounts/{balanceAccountId}/sweeps
Get all sweeps for a balance account
get /balanceAccounts/{id}
Get a balance account
patch /balanceAccounts/{id}
Update a balance account
get /balanceAccounts/{id}/paymentInstruments
Get all payment instruments for a balance account
get /balancePlatforms/{id}
Get a balance platform
get /balancePlatforms/{id}/accountHolders
Get all account holders under a balance platform
post /paymentInstrumentGroups
Create a payment instrument group
get /paymentInstrumentGroups/{id}
Get a payment instrument group
get /paymentInstrumentGroups/{id}/transactionRules
Get all transaction rules for a payment instrument group
post /paymentInstruments
Create a payment instrument
get /paymentInstruments/{id}
Get a payment instrument
patch /paymentInstruments/{id}
Update a payment instrument
get /paymentInstruments/{id}/transactionRules
Get all transaction rules for a payment instrument
post /transactionRules
Create a transaction rule
get /transactionRules/{transactionRuleId}
Get a transaction rule
delete /transactionRules/{transactionRuleId}
Delete a transaction rule
patch /transactionRules/{transactionRuleId}
Update a transaction rule