Recurring top-up updated
Adyen sends this webhook when a recurring top-up is successfully updated for a balance account.
Contains event details.
The unique identifier of the balance account for which the recurring top-up is configured.
The unique identifier of the balance platform.
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2025-03-19T10:15:30+01:00.
The ID of the resource.
The recurring top-up configuration details.
The source of the funds.
The unique identifier of the transfer instrument that is the source of the funds.
The message that is used in the top-up transfer's description body with a maximum length of 140 characters.
If the message is longer after replacing placeholders, the message is cut off at 140 characters.
A machine-readable code identifying the reason the system deactivated the top-up configuration. This field is only populated when the status is inactive.
Possible values:
- transferInstrumentDoesNotExist
- directDebitNotSupported
- accountHierarchyNotActive
- mandateNotFound
- mandateNotActive
- directDebitAmountThresholdExceeded
- topUpNotSupported
- routeNotFound
- counterpartyAccountBlocked
- counterpartyAccountInvalid
- unknown
The unique identifier of the recurring top-up configuration.
The mandate associated with the recurring top-up.
The date when the mandate was created, in ISO 8601 format.
The unique identifier of the mandate.
A human-readable description providing the specific reason or context for why the configuration was disabled. This field is only populated when the status is inactive.
A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement.
Supported characters: a-z, A-Z, 0-9.
The status of the top-up configuration.
Possible values:
-
active: the top-up is enabled and funds are pulled in.
-
inactive: the top-up is disabled and cannot be triggered.
The amount of the top-up. This can be a fixed amount or a target amount.
The fixed amount with which you want to top up the balance account.
The three-character ISO currency code.
The amount, in minor units.
The target balance for the balance account that the top-up must achieve.
The three-character ISO currency code.
The amount, in minor units.
The condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold.
The schedule for recurring top-ups. Defines when the top-up should be triggered based on time.
Possible values:
-
weekly: triggers the top-up once per week.
-
monthly: triggers the top-up once per month.
-
weekdays: triggers the top-up on weekdays only.
The balance threshold that triggers the top-up. If the balance falls below this amount, a top-up is initiated.
The three-character ISO currency code.
The amount, in minor units.
The environment from which the webhook originated.
Possible values: test, live.
When the event was queued.
Type of webhook.
When you receive a webhook, you must respond with an HTTP status code.
HTTP Responses
200 - OK
The request has succeeded.
notificationResponsestringRespond with any 2xx HTTP status code to accept the webhook.