Best practice: Webhooks
Track transfers by listening to webhooks.
This page explains how to view payout-related transfer details using your Customer Area and the Transfers API.
In your balance platform, transfers represent funds that are credited or debited from a balance account. Before any money movement occurs, payout-related transfers must be:
- Initiated according to your managed or custom payout schedule configuration, cashout, or on-demand payout request.
- Authorized by Adyen.
- Booked.
You can track the status and details of transfers to support your business operations. For recurring operations, such as scheduled payouts, we recommend that you listen to webhooks.
In other cases, you can view transfer details by using the Transfers page in your Customer Area or by making a GET /transfers request.
Requirements
Before you begin, take into account the following requirements
| Requirement | Description |
|---|---|
| Integration type | You must have an Adyen for Platforms integration. |
| API credential roles | Make sure that you have the following role:
|
| Customer Area roles | Make sure that you have the following role:
|
View a list of transfers
You can view the list of transfers in your platform by using your Customer Area or by making a GET /transfers request.
View a specific transfer
The following tabs explain how to find a specific transfer using your Customer Area or our Transfers API.
Download a transfer confirmation letter
If a user asks about a transfer, you can send them a bank transfer confirmation letter which you can download from your 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.
The transfer confimration letter includes the following information when it is available:
- The date when the letter was generated.
- The financial institution details of Adyen in the corresponding country or region.
- The name, address, and account number of the sender.
- The reference for the beneficiary.
- The name of the beneficiary.
- For transfers using US ACH, the ACH trace number.
- For transfers using the Faster Payments Service (FPS), the Faster Payment ID.
For more information about how to trace outgoing transfers, see our tracing webhooks.
To download bank transfer confirmation letters, your account must have the following role:
- Download transfer confirmation letter
Additionally, to view all personally identifiable information (PII) in the transfer confirmation letter, your account must have the following role:
- View bank transfers PII
If your account does not have this role, all PII in the confirmation letter will be masked.
To download a confirmation letter from your Customer Area:
- Go to Balances > 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.
After these steps, the transfer confirmation letter is downloaded to your device.