The funds from processing online or in-person payments can be used to automatically fund your balance account. You can then use these funds on the balance account to pay out to a third-party bank account or card. By configuring pull sweeps, you can automate pulling in funds from your merchant account based on a pre-defined amount and source.
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 funds. For automated funding, the direction is set to pull to pull funds in to the balance account from a merchant account that you specify.
You can also set sweep conditions, such as:
- Maintain a certain amount on the balance account.
- Set an amount that triggers the sweep.
When the conditions for the pull sweep are met, it triggers a request to pull funds from your merchant account. Adyen sends webhooks to your server when an incoming transfer results from a sweep.
Requirements
- Contact our Support Team to enable automated funding.
- Make sure that your server can receive and accept webhooks.
Step 1. Create a pull sweep
To set up automated funding, create a pull sweep.
-
Make a POST /balanceAccounts/{balanceAccountId}/sweeps request with the ID of the balance account in the path, and the following parameters in the request body.
Parameter name Required Description counterparty.merchantAccount 
The merchant account ID that will be the source of funds. currency The currency of the sweep. This must match one of the currencies of the balances. schedule.type The schedule when the sweep is evaluated. Set this parameter to balance. type The direction of sweep. Set this parameter to pull. triggerAmount The threshold amount that triggers the sweep. sweepAmount The amount that must be pulled in. description Your description for the resulting transfers. Here's an example of creating a pull sweep to fund a balance account from a merchant account if the balance drops below EUR 5,000.
The response returns the sweep with its unique identifier. When you successfully create a sweep, Adyen also sends a corresponding balancePlatform.balanceAccountSweep.created webhook to your server.
By default, sweeps are created with an active status. You can change it by sending an updated status in a PATCH /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} request.
Step 2. Get updates when a sweep triggers a transfer request
You can track incoming transfer requests that result from sweeps through funding webhooks. These webhooks provide the status of the incoming transfer request, from the time when Adyen received the request and the transfer was authorised, up to when the funds were added to the balance account. The webhooks will also inform you if the transfer failed.
You can also view the resulting transfer in you Balance Platform Customer Area.