Balance Control API

The Balance Control API allows you to view and manage the balances in your company and merchant accounts.

Authentication

We recommend that you use an API key to connect to the Balance Control API. You can generate an API key in your Customer Area.

Header format

To connect to the Balance Control 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: ADYEN_API_KEY' \
...

Versioning

The Balance Control API handles versioning as part of the endpoint URL. For example, to send a request to version 2 of the /balanceOverview/companies/{companyId}/balances endpoint, use:

https://balance-control-test.adyen.com/balance-control/api/v2/balanceOverview/companies/{companyId}/balances

Going live

When going live, generate an API key in your live Customer Area. You can then use the API key to send requests to https://balance-control-live.adyen.com/api/v2.

View the available balances for all merchant accounts under your company.
View all balances available for your merchant account.
Performs a balance transfer