Configure custom payout schedules

You can automate payouts from a balance account to your user's verified bank accounts by configuring a custom payout schedule. The schedule automatically initiates a payout from a balance account to your user's bank account based on a pre-defined frequency, trigger amount, and source or destination.

When setting up a custom scheduled payout, consider the cutoff times for each bank transfer method in each region. Cutoff times affect the expected time for your users to receive the funds in their bank account.

Requirements

Before you begin, take into account the following requirements:

How it works

You can configure custom payout schedules on balance accounts in your marketplace. When you create a schedule, you can define the conditions that must be met for a payout to be initiated.

You can set the following conditions:

• Set a specific date and time.
• Transfer the entire available amount or a fixed amount.
• Maintain an amount on the balance account.
• Set an amount that triggers the payout.

When all the conditions of the payout schedule are met, a transfer request is triggered automatically. Adyen sends webhooks to your server when a transfer request is triggered from a custom payout schedule.

Create a custom payout schedule

To set up automatic payouts, you must create a custom payout schedule in your Customer Area or by making a Configuration API request.

When you successfully create a custom payout schedule, Adyen sends a balancePlatform.balanceAccountSweep.created webhook with its details.

Track fund movements

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:

1. Listen to the following webhooks:
   • Transfer webhooks:
     • balancePlatform.transfer.created webhook events notify you that funds will be deducted from a balance accounts.
     • balancePlatform.transfer.updated webhook events notify of every status change of the funds transfer.
     • balanceAccountSweepExecution webhook events notify you of the success of failure of the payout executions.
   • Transaction webhooks: Adyen sends a balancePlatform.transaction.created webhook event to inform your server that funds have been deducted from a balance account.
2. Acknowledge the webhooks.
3. In the payload of the balancePlatform.transfer.updated webhook, note that:
   • The event array includes all previous transfer events.
   • The sequenceNumber defines the number of webhooks sent for the transfer, including the current one.

For more details and examples, see Payout executions.

View payout schedule details

After you create a custom payout schedule, you can view the details of the resulting scheduled payout in your Customer Area. These details include:

• Payout amount
• Source and destination of the payout
• Completed and upcoming scheduled payouts

You can view the details of all payout schedules and internal transfer schedules on the Balance account details page, under Scheduled transfers.

To view the details of a scheduled payout:

1. Go to Accounts & balances > Balance accounts.
2. In the Balance platform dropdown, select the balance platform. You can view balance accounts from one balance platform at a time.
3. In the balance account table, select a balance account ID to open the Balance account details page.
4. Under Scheduled transfers, select a scheduled payout.
5. Open the Details tab to view information about the scheduled payout.

See also