{"title":"Create recurring top-ups","category":"default","creationDate":1571779920,"content":"

You can create recurring top-ups to automatically pull funds into your balance accounts when needed. This ensures that your balance accounts are adequately funded and have sufficient balance for day-to-day activities.<\/p>\n

A recurring top-up triggers outgoing direct debit requests to a bank account, based on the settings you configure. These settings determine the amount, frequency, and source of funds for the direct debit requests. Adyen then books the funds from the top-up to your balance account.<\/p>\n

Requirements<\/h2>\n\n\n\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\n Adyen Issuing integration. <\/td>\n<\/tr>\n
API credential roles<\/a><\/strong><\/td>\nMake sure that you have the credentials for the Configuration API<\/a> with the following role:
  • BankAPI Advanced Webservice role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
Webhooks<\/a><\/strong><\/td>\nSubscribe to the following webhooks:
Capabilities<\/a><\/strong><\/td>\nTo top up using a transfer instrument, you need the following capability:
Limitations<\/strong><\/td>\nThis feature does not support on-demand top-ups.<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\nMake sure that your top-up source<\/a> has enough balance to fund the top-up.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Create a recurring top-up<\/h2>\n

To create a recurring top-up, make a POST \/balanceAccounts\/{balanceAccountId}\/recurringTopUps<\/code> request. In your request, specify the following parameters:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
balanceAccountId<\/code><\/td>\nPath<\/td>\n\"Required\"<\/span><\/td>\nThe unique identifier of the balance account.<\/td>\n<\/tr>\n
counterparty<\/code><\/td>\nRequest body<\/td>\n\"Required\"<\/span><\/td>\nAn object containing details about the counterparty that is funding the top-up. For more information, see Counterparty<\/a>.<\/td>\n<\/tr>\n
description<\/code><\/td>\nRequest body<\/td>\n\"Required\"<\/span><\/td>\nYour description for the recurring top-up.

Format<\/strong>: Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.<\/td>\n<\/tr>\n
topUpAmount<\/code><\/td>\nRequest body<\/td>\n\"Required\"<\/span><\/td>\nAn object containing the currency<\/code> and value<\/code> of the top-up amount, in minor units. Use this to specify the amount you want to top up the balance account. For more information, see Top-up amount<\/a>.<\/td>\n<\/tr>\n
trigger<\/code><\/td>\nRequest body<\/td>\n\"Required\"<\/span><\/td>\nAn object containing details about when to trigger the top-up. This includes the minimum balance value<\/code> and currency<\/code> that serves as the threshold. For more information, see Trigger<\/a>.<\/td>\n<\/tr>\n
status<\/code><\/td>\nRequest body<\/td>\n<\/td>\nThe status of the recurring top-up.

Possible values<\/strong>:
  • active<\/strong> (default)<\/li>
  • inactive<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
referenceForBeneficiary<\/code><\/td>\nRequest body<\/td>\n<\/td>\nThe reference sent to the counterparty (the source of the funds) for the direct debit request.

Format<\/strong>: