Recurring top-up created

webhookbalancePlatform.balanceAccount.recurringTopUp.created

Adyen sends this webhook when a recurring top-up is successfully created for a balance account.

Request Parameters

Required

Optional

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.

Max length: 140

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.

The unique identifier of the recurring top-up configuration.

The mandate associated with the recurring top-up.

Max length: 80

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 condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold.

The environment from which the webhook originated.

Possible values: test, live.

When the event was queued.

Type of webhook.

Response parameters

When you receive a webhook, you must respond with an HTTP status code.

HTTP Responses

200 - OK
The request has succeeded.
notificationResponsestring
Respond with any 2xx HTTP status code to accept the webhook.

Recurring top-up created

HTTP Responses

200 - OK