The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument.
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:
Docs
Main site
Need help?
Participate
Resourcescurl
-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" \
...
To use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.
The Transfers 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/btl/v3/transfers
When going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to https://balanceplatform-api-live.adyen.com/btl/v3.
Use this page to mock Transfers 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 Transfers API, which will allow you to keep building and testing even if the actual API you isn't currently available.
