PATCH /balanceAccounts/{balanceAccountId}/recurringTopUps/{topUpId}
Update the configuration of an existing recurring top up.
For more information, refer to Manage recurring top-ups.
Servers
- https://balanceplatform-api-test.adyen.com/bcl/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
balanceAccountId |
String | Yes |
The unique identifier of the balance account. |
topUpId |
String | Yes |
The unique identifier of the recurring top-up you want to update. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
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. |
referenceForBeneficiary |
String | No |
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 |
String | No |
The status of the recurring top-up. If not provided, by default, this is set to active. Possible values:
Valid values:
|
topUpAmount |
Object | No |
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. |
topUpAmount.fixed |
Object | No |
The fixed amount with which you want to top up the balance account. |
topUpAmount.target |
Object | No |
The target balance for the balance account that the top-up must achieve. |
trigger |
Object | No |
The condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold. |
trigger.threshold |
Object | No |
The balance threshold that triggers the top-up. If the balance falls below this amount, a top-up is initiated. |
trigger.threshold.value |
Integer | No |
The amount of the transaction, in minor units. |
trigger.threshold.currency |
String | No |
The three-character ISO currency code. |
trigger.schedule |
Object | No |
Contains the details about the schedule that determines when the top up is executed. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.