Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-3196247792.5 KB
Recurring top ups

Create recurring top up

Create a recurring top up configuration.

For more information, refer to Create recurring top-ups.

post/balanceAccounts/{balanceAccountId}/recurringTopUps

Path parameters

balanceAccountIdstring required

The unique identifier of the balance account.

Request body

descriptionstring required

Your description for the recurring top-up.

Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.

referenceForBeneficiarystring

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.

status'active' | 'inactive'

The status of the recurring top-up. If not provided, by default, this is set to active.

Possible values:

  • active: the top up is enabled and funds will be pulled in.

  • inactive: the top up is disabled and cannot be triggered.

Response

OK - the request has succeeded.

descriptionstring required

Your description for the recurring top-up.

Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.

idstring required

The unique identifier of the top up.

referenceForBeneficiarystring

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.

status'active' | 'inactive'

The status of the recurring top-up. If not provided, by default, this is set to active.

Possible values:

  • active: the top up is enabled and funds will be pulled in.

  • inactive: the top up is disabled and cannot be triggered.