POST /balanceAccounts/{balanceAccountId}/recurringTopUps

Create a recurring top up configuration.

For more information, refer to Create 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.

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	Yes	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: active: the top up is enabled and funds will be pulled in. inactive: the top up is disabled and cannot be triggered. Valid values: `"inactive"` `"active"`
`topUpAmount`	Object	Yes	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.fixed.value`	Integer	Yes	The amount of the transaction, in minor units.
`topUpAmount.fixed.currency`	String	Yes	The three-character ISO currency code.
`topUpAmount.target`	Object	No	The target balance for the balance account that the top-up must achieve.
`topUpAmount.target.value`	Integer	Yes	The amount of the transaction, in minor units.
`topUpAmount.target.currency`	String	Yes	The three-character ISO currency code.
`counterparty`	Object	Yes	The details about the counterparty that is funding the top-up.
`counterparty.transferInstrumentId`	String	Yes	The unique identifier of the transfer instrument that is funding the top-up.
`trigger`	Object	Yes	The condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold.
`trigger.threshold`	Object	Yes	The balance threshold that triggers the top-up. If the balance falls below this amount, a top-up is initiated.
`trigger.threshold.value`	Integer	Yes	The amount of the transaction, in minor units.
`trigger.threshold.currency`	String	Yes	The three-character ISO currency code.
`trigger.schedule`	Object	No	Contains the details about the schedule that determines when the top up is executed.
`trigger.schedule.type`	String	Yes	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. Valid values: `"monthly"` `"weekdays"` `"weekly"`

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.