In your marketplace, you can set up a schedule to automatically transfer funds between balance accounts. In addition to or instead of that, you can transfer funds between balance accounts on-demand.
Requirements
Before you begin, take into account the following requirements:
Requirement | Description |
---|---|
Integration type |
You need an Adyen for Platforms integration. |
Your API credential for the Transfers API must have the following role:
|
|
You need the following role:
|
|
|
|
If the balance accounts involved in the transfer do not belong to the same account holder, check the capabilities of the account holders:
|
|
Setup steps |
Before you begin your integration, contact our Support Team to enable transfers for the source balance account. |
Initiate an internal transfer
Select the following tabs to learn how to initiate transfers between balance accounts using your Customer Area, or using an API call.
Troubleshooting
If an internal fund transfer fails, verify if there are enough funds in the source balance account:
- Make a GET /balanceAccounts/{id} request, specifying the source balance account's ID in the path.
- Check the available balance.
- If the amount is lower than the transfer amount, you can:
- Ask your user to top up their balance account.
- Make an internal transfer from your liable balance account to your user's balance account.
If there are enough funds in the balance account, but the transfer still fails, contact our Support Team.
Get updates on the status of the transfer
For every internal transfer request, Adyen sends multiple webhooks to your server: a series of webhooks for the balance account where the transfer is an outgoing request, and a series of webhooks for the balance account where the transfer is an incoming request.
Using these webhooks, you can track the status of the transfer: received, then authorised, and finally booked. The webhooks also inform you if the transfer failed.
You can also view the transfer details in your Customer Area. Each transfer of funds between balance accounts appears in the Customer Area as two transfer entries: one for the balance account that is credited, and one for the balance account that is debited.