Automate payouts to your verified bank account by configuring sweeps. A sweep automatically pushes out or pulls in funds from a balance account based on a pre-defined schedule, amount, and source or destination.
How sweeps work
Sweeps are configured on a balance account. The configuration includes the type of the sweep and conditions, such as the schedule when the sweep is evaluated or a trigger amount. The type dictates the direction of the funds: push to push funds out of the balance account to a destination that you specify, or pull to pull funds in to the balance account from a source that you specify.
You can also set sweep conditions such as:
- Transfer the entire available amount or a fixed amount.
- Maintain an amount on the balance account.
- Set an amount that triggers the sweep.
When the conditions for the sweep are met, it triggers a transfer request. Adyen sends webhooks to your server when a transfer request results from a sweep.
For scheduled payouts, you configure a push sweep to send funds from your balance account to your transfer instrument.
How Adyen calculates the available payout amount
Before paying out your funds, Adyen verifies your available balance. The available balance refers to the amount of money on the balance account that you can spend. Verifying the available balance protects your organization from any potential obligations that may arise due to holding a negative balance.
To determine the available balance, Adyen considers an existing balance and all debits and credits that are expected to occur in the future, also called future balance changes.
-
Existing balance – The initial balance as of the day of calculation, including all amounts with a value date until the day of calculation.
-
Future balance changes – The total of all future debits and credits amounts that have a value date in the future and a booking date until the day of calculation.
The expected future debits and credits are only taken into account if their total results in a negative amount. In such a case, Adyen calculates the available balance as the existing balance minus future balance changes.
If the future balance changes result in a zero or positive amount, Adyen ignores this amount when calculating the available balance.
Below are some examples of how Adyen calculates the available balance of the balance account.
Example 1: Balance account has negative future balance changes
- At the current time T, the existing balance of the balance account is USD 100.
- The total of the debits and credits scheduled for T+1 (USD -50) and T+2 (USD +30) is USD -20.
- Because the future balance changes result in a negative amount, Adyen considers this amount for calculating the available balance.
- The available balance for the balance sweep at T is the existing balance minus future balance changes, or USD 80.
Example 2: Balance account has zero future balance changes
- At the current time T, the existing balance of the balance account is USD 100.
- The total of the debits and credits scheduled for T+1 (USD -15) and T+2 (USD +15) is USD 0.
- Because the future balance changes result in a zero amount, Adyen ignores this amount when calculating the available balance.
- The available balance for the balance sweep at T is the existing balance of USD 100.
Example 3: Balance account has positive future balance changes
- At the current time T, the existing balance of the balance account is 100 USD.
- The total of the debits and credits scheduled for T+1 (USD -50) and T+2 (USD +80) is USD 30.
- Because the future balance changes result in a positive amount, Adyen ignores this amount when calculating the available balance.
- The available balance for the balance sweep at T is the existing balance of USD 100.
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.
-
Prior to creating a push sweep, we recommend that you calculate the available transfer routes. This will enable you to design a configuration that optimally aligns with your use case. Furthermore, it minimizes the risk of transfer failures by proactively identifying supported routes and highlighting any necessary parameters.
Create a push sweep
To set up scheduled payouts, create push sweeps in your Balance Platform Customer Area.
To configure sweeps in your Balance Platform Customer Area, your account must have the Manage sweep configurations role.
-
In the navigation menu, select the merchant account linked to your balance platform.
-
In Accounts & balances > Balance accounts, select a Balance account ID.
-
In Scheduled transfers panel, select Add a transfer schedule.
-
Select Payout schedule.
-
Select Next.
-
Enter and verify the configuration details in their respective fields.
Field Description When balance on Automatically set to the balance account ID. Is more or equal to Set a trigger amount. Before paying out the funds, Adyen checks if the available balance is more than or equal to the trigger amount. Action Select Push an amount or Maintain a balance. Push this amount Select Entire available balance or Custom. Push balance to Select Transfer instrument. Transfer instrument Id Select the ID of the transfer instrument. When schedule matches Select one of the predefined schedules or Custom to define your own schedule. Schedule If you select a Custom schedule, specify the schedule or a cron expression. Select Submit. Activate Immediately after creation Description (Optional) Enter a description for the schedule. Transfer priorities Add one or multiple transfer priorities. This sets the speed at which the transfer is sent and the fees that you have to pay. -
Select Next.
-
Review the information that you provided.
-
Select Save.
The details of your scheduled payout are shown in Scheduled transfers.
The following example shows how to enter the configuration details.
Example — Pay out to a bank account
You want to pay out EUR 150 to your transfer instrument at the beginning of each month if the balance in your balance account is higher than EUR 250.
The following table shows the configuration details for this case.
| Field | Details |
|---|---|
| When balance on | BA00000000000000000000001 |
| Is more or equal to | EUR 250 |
| Action | Push an amount |
| Push this amount | Custom > EUR 150 |
| Push balance to | Transfer instrument |
| Transfer instrument Id | SE00000000000000000000001 |
| When schedule matches | Custom |
| Schedule | At 00:00, on day 1 of the month > Submit |
| Activate | Immediately after creation |
| Transfer priorities | 1. Regular For normal, low-value transactions. |
Get updates when a sweep triggers a transfer request
Track the transfer requests that result from sweeps 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. The webhooks also inform you if the transfer failed.
You can also view the resulting transfer in your Balance Platform Customer Area.
View sweep details
After you create a sweep, you can view the details of the resulting scheduled payout in your Balance Platform 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 in the Balance account details page, under Scheduled transfers. To do this, your account must have the Balance platform base role.
To view the details of a scheduled payout:
- In Accounts & balances > Balance accounts, select a Balance account ID.
- In Balance account details, under Scheduled transfers, select a scheduled payout.
- Open the Details tab to view information about the scheduled payout.
- Open the Events tab to track the event history of the scheduled payout. You can:
- View the date of the next scheduled payout.
- View a history of past payout events, including their execution dates and statuses.
Payout statuses
The table below explains the statuses you may see in the Events tab for each scheduled payout, along with their possible reasons:
| Status | Description | Possible reasons |
|---|---|---|
| Not sent | The payout schedule initiated a transfer request, but the transfer request was not successful. | Not enough balance: Check that the balance account has enough funds. If needed, you can top up the balance account. Missing capabilities: Verify that the account holder is allowed to use the required capabilities. |
| Failed | The payout failed. | Route not found: The transfer route may be misconfigured. Check and update the route priorities. Transfer instrument does not exist: The transfer instrument associated with this scheduled transfer was deleted. You may need to create a new transfer instrument. Unauthorized: The transfer was not authorized. |
| Success | The transfer was created. The details include the transfer amount, the transfer ID, and a link to the transfer details page. |
Not applicable. |