This page explains how to make a payout request to transfer funds to third-party bank accounts.
After you make the payout request, you can track the status of the transfer by listening to webhooks.
Requirements
Before you make a payout request:
- Ensure your API credential has the roles to use with the Transfers API.
- Ensure that your server receives and accepts webhooks.
- Contact our Support Team:
- To enable transfers for the source balance account.
- If you want to configure a default transfer description for your platform.
Initiate a payout
To send an on-demand payout, make a POST /transfers request, specifying:
| Parameter name | Required | Description |
|---|---|---|
| amount |  |
The amount and the currency of the transfer. |
| balanceAccountId | |
The balance account from which funds are deducted. |
| category | |
Set to bank. |
| counterparty.bankAccount | |
Contains details about the destination bank account and its owner. |
| priority | |
The priority of the bank transfer, which affects the transfer speed and the fees you have to pay. |
| priorities | Required if priority is not included. |
The list of priorities for the bank transfer. For more details see fallback priorities. |
| description | Your description for the transfer request, which is used by most recipient banks. Check the character limit based on the location of the counterparty bank account and the priority. | |
| reference | Your reference for the transfer. This is only used within your platform and not sent to the recipient. If you do not provide this in the request, Adyen generates a unique reference. | |
| referenceForBeneficiary | Your reference for the transfer, which is also sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses. |
If the transfer request is successful, you receive an HTTP 200 OK response containing an id of the transfer request.
Fallback priorities
Depending on the transfer location, currency, and counterparty, a transfer can be subject to additional requirements or limitations. These limitations may affect the transfer route for some priorities. To prevent problems with transfer routes, you can specify a list of priorities for your transfer.
When you specify a list of priorities, Adyen tries to transfer the funds using the first priority in the list. If a transfer route is not available for this priority, Adyen tries to transfer again, but using the next priority in the list.
The following code sample shows how to include a list of priorities.
In this example, a transfer route for the priority fast was not available, so Adyen transferred the funds using the priority regular.
The response contains:
- The
routingDetailsobject, specifying why the first priority was not selected. - The selected
priority.
Trigger additional reviews
To better control money movement in your , you can trigger additional reviews for transfers. Additional reviews require a member of your team to verify a transfer before Adyen processes it.
You can trigger an additional review by including the review object in the POST /transfers request. In the object, specify the following parameter:
| Parameter name | Required | Description | |
|---|---|---|---|
| review.numberOfApprovalsRequired | |
Specifies the number of approvals required to process the transfer. Possible values: 1. Currently, it is possible to request only one additional review per transfer. |
The following code sample shows how to include include the review object.
If the transfer request is successful, you receive a response containing the following parameters:
| Parameter name | Description |
|---|---|
| review.numberOfApprovalsCompleted | Shows the number of approvals completed for the transfer. |
| review.numberOfApprovalsRequired | Shows the number of approvals required to process the transfer. |
| review.scaOnApproval | Shows the status of the SCA process. Possible values: notApplicable. |
After triggering the review, a member of your team must approve the transfer before Adyen continues processing it.
Get updates on the status of the transfer
Track the transfer request through webhooks that Adyen sends to your server. The webhooks provide the status of the request, from the time when Adyen received the request and the transfer was authorised, up to when the transfer was booked and deducted from the balance account. Additionally, you can find the estimated arrival time of the funds.
You can also view the transfer in your Customer Area.
Test the payout flow
To test the payout flow, make a POST /transfers request.
The currency and priority of the transfer request must match the values shown in the following table.