On-demand payouts let you trigger payments to transfer instruments, such as your payout account, outside a regular schedule. You can use this feature to manage funds based on regional bank transfer cut-off times and make sure that account holders receive funds when they need them.
Requirements
Before you begin, take into account the following requirements, limitations, and preparations.
| Requirement | Description |
|---|---|
| Integration type | This feature is supported with an Adyen balance platform integration. |
| Customer Area roles | To manage sweep configurations in the Customer Area, make sure that your user account has the following roles:
|
| Webhooks | Configure your server to receive and accept webhooks. |
| Limitations | Regional bank transfer cutoff times affect when funds reach the account holder. Consider these times before you trigger an on-demand payout. |
| Setup steps | Before you begin, contact our Support Team to configure a default transfer description for your balance platform. Before submitting a transfer request, we recommend that you calculate the available transfer routes. This enables you to pay out funds faster and minimize the risk of payout failures. |
Make a transfer request
To set up on-demand payouts, use your Customer Area or make a POST /transfers request. The following tabs explain both methods.
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.