The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account.
To connect to the Balance Control API, you must authenticate your requests with an API key or basic auth username and password. To learn how you can generate these, see API credentials.Here is an example of authenticating a request with an API key:
curl
-H "X-API-Key: Your_API_key" \
-H "Content-Type: application/json" \
...
Note that when going live, you need to generate API credentials to access the live endpoints.
The Balance Control 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://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer
Use this page to mock Adyen Balance Control API in your testing and development.
Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Adyen Balance Control API, which will allow you to keep building and testing even if the actual API you isn't currently available.