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

After you create a recurring top-up, we automatically trigger top-ups to your balance account according to the settings you configured.<\/p>\n

If you need to view or change these settings, or delete a recurring top-up, you can do so using the Configuration API<\/a> or the Customer Area<\/a>.<\/p>\n

Requirements<\/h2>\n\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 enterprise payouts<\/a> integration. <\/td>\n<\/tr>\n
API credential roles<\/a><\/strong><\/td>\nTo configure top-up schedules using the API<\/a>, make 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
Customer Area roles<\/a><\/strong><\/td>\nTo configure top-up schedules using the Customer Area<\/a>, make sure that you have the following roles:
  • Balance platform base role<\/strong><\/li>
  • Configure scheduled payouts<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
Webhooks<\/a><\/strong><\/td>\nSubscribe to the following webhooks:
Capabilities<\/strong><\/td>\nTo top up using a transfer instrument, you need the following capability:
  • receiveFromTransferInstrument<\/strong><\/span><\/li><\/ul>
    Before attempting a transfer, verify that this capability is active and has a valid verificationStatus<\/code>. You can check this via the verificationStatus<\/a>.
    <\/td>\n<\/tr>\n
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

View recurring top-ups<\/h2>\n

You can view recurring top-ups using the API or your Customer Area.<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

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

You can update a recurring top-up using the API or your Customer Area.<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

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

You can delete a recurring top-up using the API or your Customer Area.<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

See also<\/h2>\n
\n

Create recurring top-ups<\/h6>

Learn how to configure recurring top-ups for your balance accounts.<\/p><\/div><\/p><\/a>

Top-up webhooks<\/h6>

Stay updated about changes to the recurring top-ups on your platform.<\/p><\/div><\/p><\/a><\/div>\n","url":"https:\/\/docs.adyen.com\/payouts\/payout-service\/top-up-balance-accounts\/manage-recurring-top-ups","articleFields":{"Menu":"Manage recurring top-ups","description":"Learn how to view, change, and delete recurring top-ups.","last_edit_on":"11-09-2020 17:20","parameters":{"directoryPath":"\/payouts\/payout-service","integrationType":"payouts"}},"algolia":{"url":"https:\/\/docs.adyen.com\/payouts\/payout-service\/top-up-balance-accounts\/manage-recurring-top-ups","title":"Manage recurring top-ups","content":"After you create a recurring top-up, we automatically trigger top-ups to your balance account according to the settings you configured.\nIf you need to view or change these settings, or delete a recurring top-up, you can do so using the Configuration API or the Customer Area.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\n Adyen enterprise payouts integration. \n\n\nAPI credential roles\nTo configure top-up schedules using the API, make sure that you have the credentials for the Configuration API with the following role:BankAPI Advanced Webservice role\n\n\nCustomer Area roles\nTo configure top-up schedules using the Customer Area, make sure that you have the following roles:Balance platform base roleConfigure scheduled payouts\n\n\nWebhooks\nSubscribe to the following webhooks: Configuration webhooks Transfer webhooks Transaction webhooks\n\n\nCapabilities\nTo top up using a transfer instrument, you need the following capability: receiveFromTransferInstrument Before attempting a transfer, verify that this capability is active and has a valid verificationStatus. You can check this via the verificationStatus. \n\n\nLimitations\nThis feature does not support on-demand top-ups.\n\n\nSetup steps\nMake sure that your top-up source has enough balance to fund the top-up.\n\n\n\nView recurring top-ups\nYou can view recurring top-ups using the API or your Customer Area.\n\n\n \n \n \n \n\n\nUpdate a recurring top-up\nYou can update a recurring top-up using the API or your Customer Area.\n\n\n \n \n \n \n\n\nDelete a recurring top-up\nYou can delete a recurring top-up using the API or your Customer Area.\n\n\n \n \n \n \n\n\nSee also\n\nCreate recurring top-upsLearn how to configure recurring top-ups for your balance accounts.Top-up webhooksStay updated about changes to the recurring top-ups on your platform.\n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Top up accounts","lvl4":"Manage recurring top-ups"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/payouts","lvl2":"https:\/\/docs.adyen.com\/payouts\/payout-service","lvl3":"https:\/\/docs.adyen.com\/payouts\/payout-service\/top-up-balance-accounts","lvl4":"\/payouts\/payout-service\/top-up-balance-accounts\/manage-recurring-top-ups"},"levels":5,"category":"","category_color":"","tags":["Manage","recurring","top-ups"]}}