Best practice: Webhooks
Track transfers by listening to webhooks.
This page explains how to view transfer details using the API and your Customer Area.
Transfers represent funds that are credited or debited from a balance account. Before any money movement occurs, transfers must be:
- Initiated by events such as paying out to third parties or moving funds between balance accounts.
- Authorized by Adyen.
- Booked your balance account.
You can track the status and details of transfers to support your business operations. For recurring operations, such as reconciling transfers, we recommend that you listen to webhooks.
In other cases, you can view transfer details by making a GET /transfers request or using the Transfers page in your Balance Platform Customer Area.
Before you begin
To view transfer details, ensure that you have the required permissions:
- To make a GET /transfers request, your API credential needs the TransferService Webservice Retrieve role.
- To use your Balance Platform Customer Area, your user account needs one of the following roles:
- Balance platform base role
- View transfers
View a list of transfers
You can view the list of transfers in your by making a GET /transfers request, or in your Balance Platform Customer Area
To get a list of transfers, make a GET /transfers request including the query parameters in the following table:
| Query parameter | Required | Description | |
|---|---|---|---|
| createdSince |  |
Specifies that the response must include transfers created after this date. The date must be in ISO 8601 format. For example: 2023-10-12T09:20:30+01:00. |
|
| createdUntil | |
Specifies that the response must include transfers created before this date. The date must be in ISO 8601 format. For example: 2023-10-13T08:45:30+01:00. |
|
| balanceAccountId | Limits the returned list to the transfers related to the specified balance account ID. | ||
| accountHolderId | Limits the returned list to the transfers related to the specified account holder ID. | ||
| limit | The number of transfers returned per page. |
You must provide at least one of the unique identifiers in your request.
The following example shows a GET /transfers request for a list that includes:
- Transfers created after October 12, 2023 at 9:20 AM, but before October 13, 2023 at 8:45 AM.
- A limit of 5 transfers per page.
The response contains the following parameters:
| Response parameter | Description |
|---|---|
| data | An array that contains all the transfers that match the query parameters. |
| _links | An object that contains links to the next or previous page, when applicable. |
View a specific transfer
The following tabs explain how to find a specific transfer using our API or your Balance Platform Customer Area.
To get the details of a specific transfer, make a GET /transfers/{id} request, specifying the transfer id in the path.
The response contains all the details of the transfer. Take note of the following:
| Response parameter | Description | |
|---|---|---|
| amount | An object that contains the amount and currency of the transfer funds. | |
| direction | Specifies whether the transfer funds are incoming or outgoing. | |
| events | An array that contains the event history of the transfer. | |
| reference | Your internal reference for the transfer. | |
| status | The current status of the transfer. For example: received, authorised, or booked. |
Download a transfer confirmation letter
If a beneficiary asks about a transfer, you can send them a bank transfer confirmation letter which you can download from your Balance Platform Customer Area. The letter is in PDF format, shows the transfer details and the beneficiary account, and confirms that Adyen has sent the instruction to carry out the transfer.
To download bank transfer confirmation letters, your account must have the following role:
- Download transfer confirmation letter
To download a confirmation letter from your Balance Platform Customer Area:
- Go to Transfers.
- Set filters:
- Select More filters.
- Set Status to Booked.
- Set Type to Bank transfer.
- Select Apply all.
- Select the Transfer ID of the transfer for which you want to download a confirmation letter.
- Select Transfer confirmation letter.