Qodex.ai

Configuration API (v2)

Number of APIs: 46

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" \n-H "X-API-Key: YOUR_API_KEY" \n...

Alternatively, you can use the username and password to connect to the API using basic authentication. For example:

curl
-H "Content-Type: application/json" \n-U "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \n...

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.

  1. Platform-/balancePlatforms/:id - Get a balance platform GET {{baseUrl}}/balancePlatforms/:id

  2. Platform-/balancePlatforms/:id/accountHolders - Get all account holders under a balance platform GET {{baseUrl}}/balancePlatforms/:id/accountHolders

  3. Grant offers-/grantOffers - Get all available grant offers GET {{baseUrl}}/grantOffers?accountHolderId=accountHolderId_example

  4. Grant offers-/grantOffers/:grantOfferId - Get a grant offer GET {{baseUrl}}/grantOffers/:grantOfferId

  5. Network tokens-/networkTokens/:networkTokenId - Get a network token GET {{baseUrl}}/networkTokens/:networkTokenId

  6. Network tokens-/networkTokens/:networkTokenId - Update a network token PATCH {{baseUrl}}/networkTokens/:networkTokenId

  7. Account holders-/accountHolders - Create an account holder POST {{baseUrl}}/accountHolders

  8. Account holders-/accountHolders/:id - Get an account holder GET {{baseUrl}}/accountHolders/:id

  9. Balance accounts-/balanceAccounts/:id/paymentInstruments - Get payment instruments linked to a balance account GET {{baseUrl}}/balanceAccounts/:id/paymentInstruments

  10. Account holders-/accountHolders/:id - Deactivate an account holder PATCH {{baseUrl}}/accountHolders/:id