On-demand payouts give you the flexibility to trigger a payout off-schedule. When triggering an on-demand payout, consider the cutoff times for each bank transfer method in each region. Cutoff times affect the expected time for the account holders to receive the funds in their bank account.
This page explains how to pay out on-demand to your transfer instruments.
Requirements
- Make sure that your server can receive and accept webhooks.
- Contact our Support Team if you want to configure a default transfer description for your balance platform.
- Make sure that your user account has the Manage sweep configurations role.
Get transfer routes
Before submitting a transfer request, we recommend that you calculate the available transfer routes. This enables you to design a configuration that optimally aligns with your use case. It also minimizes the risk of transfer failures by identifying supported routes and highlighting any necessary parameters.
1. Make a transfer request
To set up on-demand payouts, use your Balance Platform Customer Area or make a POST /transfers request.
2. Get updates on the status of the transfer
You can view the status of funds transfers initiated by a payout in your Customer Area, or track them by listening to webhooks.
To track the status of funds transfers initiated by a payout:
- Listen to the following webhooks:
- Transfer webhooks: Adyen sends a balancePlatform.transfer.created webhook to inform your server that funds will be deducted from a balance accounts, and balancePlatform.transfer.updated webhooks after every status change.
- Transaction webhooks: Adyen sends a balancePlatform.transaction.created webhook to inform your server that funds have been deducted from a balance account.
- Acknowledge the webhooks.
- In the payload of the balancePlatform.transfer.updated webhook, note that:
- The
eventarray includes all previous transfer events. - The
sequenceNumberdefines the number of webhooks sent for the transfer, including the current one.
- The
For more details and examples, see Payout webhooks.
Troubleshooting
The following examples show some common issues you may encounter when attempting to make a transfer.
Transfers to counterparty bank account is blocked.
This error indicates that your bank returned a previous payout attempt. Some return codes indicate a temporary issue, and can be retried. Others indicate a permanent issue and result in this error message.
Solution
To avoid this error:
- Listen to transfer webhooks. These webhooks tell you when your bank returns a payout.
- Read the return reason. If the reason indicates a final status, do not retry the transfer. Only retry payouts that have return reason codes that are recommended to be retried.
- Make sure that your bank account details are updated.
To fix this error:
- Reach out to your Adyen contact to update your bank account details.
- Retry the payout by making a new transfer request.