Pay out on a schedule

Automate payouts to your user's verified bank accounts 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 will configure a push sweep to send funds from your user's balance account to their transfer instrument.

How Adyen calculates the available payout amount

Before paying out funds to your users, Adyen verifies their available balance. The available balance refers to the amount of money on the balance account that the user can spend. Verifying the available balance protects you as a marketplace from any potential obligations that may arise due to users 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.

Requirements

• Make sure that your server can receive and accept webhooks.
• Contact Support Team if you want to configure a default transfer description for your marketplace.
• Make sure that the user is allowed to use the sendToTransferInstrument capability. From LEM API v3, this capability is verified at the level of the transfer instrument, such as a bank account. This means that transfers are possible to a verified transfer instrument independently of the verification status of other transfer instruments that the legal entity has.

• 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.

Get transfer routes

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.

Step 1. Create a push sweep

To set up scheduled payouts, create push sweeps by using your Customer Area, or by making a POST /balanceAccounts/{balanceAccountId}/sweeps request.

Step 2. 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 Customer Area.

View sweep details

After you create a sweep, 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 in the Balance account details page, under Scheduled transfers. To do this your account must have one of the following roles:

• Balance platform base role
• Balance platform admin role

To view details:

1. In Accounts & balances > Balance accounts, select a Balance account ID.
2. In Balance account details, under Scheduled transfers, select a scheduled payout.
3. Select View details.

Transfer statement description character limits

The following limits apply to the length and the characters that you can use when setting a transfer statement description based on the location of the counterparty and the priority.

¹ In these regions, the description and referenceForBeneficiary characters are combined and shown in a single field on the bank application or statement. The description appears first. If the character limit is reached, the referenceForBeneficiary is not included.

See also