Transfers API

https://balanceplatform-api-test.adyen.com/btl/v4
Click to copy

Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.

This API provides endpoints that you can use to transfer funds, whether when paying out to a transfer instrument, sending funds to third parties for users with business bank accounts, or to request a payout for a grant offer. The API also supports use cases for getting transactions for business bank accounts and getting grants and its outstanding balances. .

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" \
-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" \
...

Roles and permissions

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.

Versioning

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/v4/transfers

Going live

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/v4.

Get a capital account
Request a grant payout
Get grant reference details
Get all transactions
Get a transaction
Transfer funds
Return a transfer