Create recurring top up

post/balanceAccounts/{balanceAccountId}/recurringTopUps

Create a recurring top up configuration.

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

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{balanceAccountId}/recurringTopUps

Path Parameters

Required

Optional

The unique identifier of the balance account.

Request Parameters

Required

Optional

The details about the counterparty that is funding the top-up.

Max length: 140

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.

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 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.

The currency and value to be added to the balance account, specified in minor units. 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.

Response parameters

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.

HTTP Responses

200 - OK
The request has succeeded.
counterpartyobject
The details about the counterparty that is funding the top-up.
transferInstrumentIdstring
The unique identifier of the transfer instrument that is funding the top-up.
descriptionstring
Max length: 140
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
The unique identifier of the top up.
referenceForBeneficiarystring
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.
statusstring
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.

topUpAmountobject
The currency and value to be added to the balance account, specified in minor units. This can be a fixed amount or a target amount.
fixedobject
The fixed amount with which you want to top up the balance account.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
targetobject
The target balance for the balance account that the top-up must achieve.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
triggerobject
The condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold.
scheduleobject
Contains the details about the schedule that determines when the top up is executed.
typestring
The type of schedule at which the top up is executed.

weekdays: pull in funds Monday-Friday at 07:00 AM in the local timezone of the balance account.

weekly: pull in funds every Monday at 07:00 AM in the local timezone of the balance account.

monthly: pull in funds every first of the month at 07:00 AM in the local timezone of the balance account.

null (default): continuous monitoring.

thresholdobject
The balance threshold that triggers the top-up. If the balance falls below this amount, a top-up is initiated.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Create recurring top up

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity