Adyen sends this webhook when you successfully update a sweep.
Contains event details.
The unique identifier of the balance account for which the sweep was configured.
The unique identifier of the balance platform.
Contains information about the sweep resource that triggered the event.
The destination or the source of the funds, depending on the sweep
merchantAccount is required.
The unique identifier of the destination or source balance account.
You can only use this for periodic sweep schedules such as
schedule.type daily or monthly.
The merchant account that will be the source of funds.
You can only use this parameter with sweeps of
type pull and
schedule.type balance, and if you are processing payments with Adyen.
The unique identifier of the destination or source transfer instrument depending on the sweep
. To set up automated top-up sweeps to balance accounts, use this parameter in combination with a
merchantAccount and a sweep
type of pull. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.
The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.
If the message is longer after replacing placeholders, the message will be cut off at 140 characters.
The unique identifier of the sweep.
The reason for disabling the sweep.
The schedule when the
triggerAmount is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.
A cron expression that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, 30 17 * * MON schedules a sweep every Monday at 17:30.
The expression must have five values separated by a single space in the following order:
Day of the month: 1-31
Month: 1-12 or JAN-DEC
Day of the week: 0-7 (0 and 7 are Sunday) or MON-SUN.
The following non-standard characters are supported: *, L, #, W and /. See crontab guru for more examples.
type is cron.
The schedule type.
cron: push out funds based on a
daily: push out funds daily at 07:00 AM CET.
weekly: push out funds every Monday at 07:00 AM CET.
monthly: push out funds every first of the month at 07:00 AM CET.
balance: pull in funds instantly if the balance is less than or equal to the
triggerAmount. You can only use this for sweeps of
typepull and when the source is a
transferInstrument. If the source is transferInstrument, merchant account identifier is still required, with which you want to process the transaction.
The status of the sweep. If not provided, by default, this is set to active.
active: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration.
inactive: the sweep is disabled and cannot be triggered.
The amount that must be pushed out or pulled in. You can configure either
targetAmount, not both.
The amount that must be available in the balance account after the sweep. You can configure either
targetAmount, not both.
The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The
triggerAmount is evaluated according to the specified
typepull, if the balance is less than or equal to the
triggerAmount, funds are pulled in to the balance account.
typepush, if the balance is more than or equal to the
triggerAmount, funds are pushed out of the balance account.
The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to push.
push: push out funds to a destination balance account or transfer instrument.
pull: pull in funds from a source merchant account, transfer instrument, or balance account.
The environment from which the webhook originated.
Possible values: test, live.
Type of webhook.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.