Configuration API

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

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.

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
get/accountHolders/{id}/transactionRules
Get all transaction rules for an account holder
post/balanceAccounts
Create a balance account
get/balanceAccounts/{balanceAccountId}/sweeps
Get all sweeps for a balance account
post/balanceAccounts/{balanceAccountId}/sweeps
Create a sweep
get/balanceAccounts/{id}
Get a balance account
patch/balanceAccounts/{id}
Update a balance account
get/balanceAccounts/{id}/paymentInstruments
Get payment instruments linked to a balance account
get/balanceAccounts/{id}/transactionRules
Get all transaction rules for a balance account
get/balancePlatforms/{id}
Get a balance platform
get/balancePlatforms/{id}/accountHolders
Get all account holders under a balance platform
get/balancePlatforms/{id}/transactionRules
Get all transaction rules for a balance platform
get/cardorders
Get a list of card orders
get/cardorders/{id}/items
Get card order items
get/grantAccounts/{id}
Get a grant account
get/grantOffers
Get all available grant offers
get/grantOffers/{grantOfferId}
Get a grant offer
get/networkTokens/{networkTokenId}
Get a network token
patch/networkTokens/{networkTokenId}
Update a network token
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
post/paymentInstruments/reveal
Reveal the data of a payment instrument
get/paymentInstruments/{id}
Get a payment instrument
patch/paymentInstruments/{id}
Update a payment instrument
get/paymentInstruments/{id}/reveal
Get the PAN of a payment instrument
get/paymentInstruments/{id}/transactionRules
Get all transaction rules for a payment instrument
post/pins/change
Change a card PIN
post/pins/reveal
Reveal a card PIN
get/publicKey
Get an RSA public key
get/registeredDevices
Get a list of registered SCA devices
post/registeredDevices
Initiate the registration of an SCA device
delete/registeredDevices/{id}
Delete a registration of an SCA device
patch/registeredDevices/{id}
Complete the registration of an SCA device
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
post/transferRoutes/calculate
Calculate transfer routes
post/validateBankAccountIdentification
Validate a bank account