Get recurring top ups for a specific balanceAccountId

get/balanceAccounts/{balanceAccountId}/recurringTopUps

View all recurring top ups configured for a specific balanceAccountId.

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

Endpoint destination URL

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

Query Parameters

Required

Optional

The cursor used for pagination. Required if you want to see the next or previous page of results.

Minimum: 1Maximum: 100

The number of items to return per page. Value must be between 1 and 100.

Path Parameters

Required

Optional

The unique identifier of the balance account.

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.
linkobject
firstobject
The link to the first page of the list.
hrefstring
lastobject
The link to the last page of the list.
hrefstring
nextobject
The link to the next page of the list.
hrefstring
previousobject
The link to the previous page of the list.
hrefstring
selfobject
The link to the list page you are currently viewing.
hrefstring
recurringTopUpsarray[object]
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.
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.
404 - Not Found
The recurring top up was not found
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.
500 - Internal Server Error
The server could not 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.

Get recurring top ups for a specific balanceAccountId

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

500 - Internal Server Error