You can return previously transferred funds back to the source account. Returns have the same transfer ID as the original transfer.
This page explains how to return funds using our API.
Before you begin
- Check the capabilities of the source and destination account holders. You can move funds between balance accounts of the same account holder. However, if the balance accounts don't belong to the same account holder, the account holders must be allowed to use the corresponding capability:
- sendToBalanceAccount: The account holder that owns the source balance account must be allowed to use this capability.
- receiveFromBalanceAccount: The account holder that owns the destination balance account must be allowed to use this capability.
- Ensure that your API credential:
- Has access to the Transfers API.
- Has the TransferService Webservice Initiate role.
- Ensure that your server can receive and accept webhooks.
- Contact our Support Team:
- To enable transfers for the source balance account.
- If you want to configure a default return description for your marketplace.
Initiate a return
To return an internal transfer, make a POST /transfers/{transferId}/return request, where {transferId} is the ID of the original incoming transfer that is returned in the webhooks.
The following table shows the request parameters.
| Parameter | Required | Description |
|---|---|---|
| amount |  |
Object containing the currency and value of the transfer. |
| reference | Your unique reference for the transfer. |
The following code sample shows how to return EUR 100 previously received through a transfer with the ID 123XYZABC456DEF7.
After a successful request, you get the following sample response, which includes the id of the return.
Get updates on the status of the return
Track returns by using the webhooks that Adyen sends to your server. The webhooks provide the status of the request and also inform you if the request failed.
You can also view the return in your Customer Area.