Adyen sends this webhook when you successfully update a balance account.
Contains event details.
The unique identifier of the account holder associated with the balance account.
List of balances with the amount and currency.
The three-character ISO currency code of the balance.
The default three-character ISO currency code of the balance account. The default value is EUR.
A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired.
Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
List of payment instruments associated with the balance account.
Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).
The key must be a three-character ISO currency code in uppercase. For example, EUR. The value must be an object containing the sweep configuration.
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 if you are processing payments with Adyen. This can only be used for sweeps of type pull and schedule.type balance.
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.
The status of the sweep. If not provided, by default, this is set to active.
Possible values:
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 sweepAmount or targetAmount, not both.
The amount of the transaction, in minor units.
The amount that must be available in the balance account after the sweep. You can configure either sweepAmount or targetAmount, not both.
The amount of the transaction, in minor units.
The unique identifier of the destination or source transfer instrument.
You can also use this in combination with a merchantAccount and a type pull to start a direct debit request from the source transfer instrument. To use this feature, reach out to your Adyen contact.
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 schedule.type.
For type pull, if the balance is less than or equal to the triggerAmount, funds are pulled in to the balance account.
For type push, if the balance is more than or equal to the triggerAmount, funds are pushed out of the balance account.
The amount of the transaction, in minor units.
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.
Possible values:
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 time zone of the balance account. For example, Europe/Amsterdam. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the list of time zone codes.
The environment from which the webhook originated.
Possible values: test, live.
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.
The request has succeeded.
Show more Show lessRespond with HTTP 200 OK and [accepted] in the response body to accept the webhook.