{"title":"Top-up webhooks","category":"default","creationDate":1571779920,"content":"<p>Managing recurring top-ups using the Top-up API is an asynchronous process. A successful API response does not necessarily indicate that a recurring top-up is successfully created, updated, or deleted.<\/p>\n<p>To stay up to date about changes to the recurring top-ups in your platform, we recommend that you subscribe to  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration webhooks<\/a>.<\/p>\n<p>To stay up to date about the direct debit triggered by the recurring top-up, we recommend that you subscribe to  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfer webhooks<\/a> and  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transaction webhooks<\/a>.<\/p>\n<h2>Requirements<\/h2>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\"> Adyen Issuing integration.  <\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/webhooks\">Webhooks<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Subscribe to the following webhook(s): <ul><li><strong> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration webhooks<\/a><\/strong>: to stay updated about changes to recurring top-ups in your platform.<\/li><li><strong> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfer webhooks<\/a><\/strong>: to stay updated about status changes to the direct debit triggered by the recurring top-up.<\/li><li><strong> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transaction webhooks<\/a><\/strong>: to stay updated about the movement of funds as a result of a triggered direct debit top-up.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin: <ul><li>Make sure that your server can <a href=\"\/pt\/issuing\/set-up-webhooks\">receive and accept webhooks<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Configuration webhooks<\/h2>\n<p>To stay updated about changes to recurring top-ups in your balance platform, you can listen to the following webhooks:<\/p>\n<ul>\n<li><code>balancePlatform.balanceAccount.recurringTopUp.created<\/code>: sent when a new recurring top-up is successfully created.<\/li>\n<li><code>balancePlatform.balanceAccount.recurringTopUp.updated<\/code>: sent when an existing recurring top-up is successfully updated.<\/li>\n<li><code>balancePlatform.balanceAccount.recurringTopUp.deleted<\/code>: sent when an existing recurring top-up is successfully deleted.<\/li>\n<\/ul>\n<p>In these webhooks, pay attention to the following fields:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>accountId<\/code><\/td>\n<td style=\"text-align: left;\">The unique identifier of the balance account on which the recurring top-up is configured.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>webhookTopUpConfiguration<\/code><\/td>\n<td style=\"text-align: left;\">An object that contains the details of the recurring top-up.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>type<\/code><\/td>\n<td style=\"text-align: left;\">The type of webhook, indicating whether a recurring top-up is created, updated, or deleted.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>Examples<\/h3>\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#recurring-top-up-created\">\n                                    <h4 class=\"adl-accordion__title\">Recurring top-up created<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"\\n{\\n   \\\"data\\\": {\\n       \\\"accountId\\\": \\\"BA00000000000000000000001\\\",\\n       \\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n       \\\"webhookTopUpConfiguration\\\": {\\n           \\\"id\\\": \\\"TU0000000000000000000000000001\\\",\\n           \\\"status\\\": \\\"inactive\\\",\\n           \\\"trigger\\\": {\\n               \\\"threshold\\\": {\\n                   \\\"value\\\": 5000,\\n                   \\\"currency\\\": \\\"EUR\\\"\\n               }\\n           },\\n           \\\"description\\\": \\\"Testing recurring top up\\\",\\n           \\\"topUpAmount\\\": {\\n               \\\"fixedAmount\\\": {\\n                   \\\"value\\\": 1000,\\n                   \\\"currency\\\": \\\"EUR\\\"\\n               }\\n           },\\n           \\\"counterparty\\\": {\\n               \\\"transferInstrumentId\\\": \\\"TI00000000000000000000001\\\"\\n           }\\n       }\\n   },\\n   \\\"type\\\": \\\"balancePlatform.balanceAccount.recurringTopUp.created\\\",\\n   \\\"timestamp\\\": \\\"2026-02-26T09:39:14.25Z\\\",\\n   \\\"environment\\\": \\\"test\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#recurring-top-up-updated\">\n                                    <h4 class=\"adl-accordion__title\">Recurring top-up updated<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"\\n{\\n   \\\"data\\\": {\\n       \\\"accountId\\\": \\\"BA00000000000000000000001,\\n       \\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n       \\\"webhookTopUpConfiguration\\\": {\\n           \\\"id\\\": \\\"TU0000000000000000000000000001\\\",\\n           \\\"status\\\": \\\"inactive\\\",\\n           \\\"trigger\\\": {\\n               \\\"threshold\\\": {\\n                   \\\"value\\\": 5000,\\n                   \\\"currency\\\": \\\"EUR\\\"\\n               }\\n           },\\n           \\\"description\\\": \\\"Updating description\\\",\\n           \\\"topUpAmount\\\": {\\n               \\\"fixedAmount\\\": {\\n                   \\\"value\\\": 1000,\\n                   \\\"currency\\\": \\\"EUR\\\"\\n               }\\n           },\\n           \\\"counterparty\\\": {\\n               \\\"transferInstrumentId\\\": \\\"TI00000000000000000000001\\\"\\n           }\\n       }\\n   },\\n   \\\"type\\\": \\\"balancePlatform.balanceAccount.recurringTopUp.updated\\\",\\n   \\\"timestamp\\\": \\\"2026-02-26T09:43:02.401Z\\\",\\n   \\\"environment\\\": \\\"test\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#recurring-top-up-deleted\">\n                                    <h4 class=\"adl-accordion__title\">Recurring top-up deleted<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"\\n{\\n   \\\"data\\\": {\\n       \\\"accountId\\\": \\\"BA00000000000000000000001\\\",\\n       \\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n       \\\"webhookTopUpConfiguration\\\": {\\n           \\\"id\\\": \\\"TU0000000000000000000000000001\\\",\\n           \\\"status\\\": \\\"inactive\\\",\\n           \\\"trigger\\\": {\\n               \\\"threshold\\\": {\\n                   \\\"value\\\": 5000,\\n                   \\\"currency\\\": \\\"EUR\\\"\\n               }\\n           },\\n           \\\"description\\\": \\\"Testing recurring top up\\\",\\n           \\\"topUpAmount\\\": {\\n               \\\"fixedAmount\\\": {\\n                   \\\"value\\\": 1000,\\n                   \\\"currency\\\": \\\"EUR\\\"\\n               }\\n           },\\n           \\\"counterparty\\\": {\\n               \\\"transferInstrumentId\\\": \\\"TI00000000000000000000001\\\"\\n           }\\n       }\\n   },\\n   \\\"type\\\": \\\"balancePlatform.balanceAccount.recurringTopUp.deleted\\\",\\n   \\\"timestamp\\\": \\\"2026-02-26T09:34:03.894Z\\\",\\n   \\\"environment\\\": \\\"test\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<h2>Transfer webhooks<\/h2>\n<p>When a top-up is triggered on your balance platform, Adyen sends the following transfer webhooks:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transfer.created<\/a>: which informs your server that an outgoing direct debit request is initiated from a balance account in your balance platform.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.updated\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transfer.updated<\/a>: which informs your server of the transfer status changes.<\/li>\n<\/ul>\n<h3>Identify top-up related transfer webhooks<\/h3>\n<p>You can identify transfer webhooks triggered by payout-related events by looking at the following values:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<th style=\"text-align: left;\">Value<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>category<\/code><\/td>\n<td style=\"text-align: left;\">The category of the transfer.<\/td>\n<td style=\"text-align: left;\"><strong>bank<\/strong><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>type<\/code><\/td>\n<td style=\"text-align: left;\">Specifies the type of the transfer.<\/td>\n<td style=\"text-align: left;\"><strong>bankDirectDebit<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>Examples<\/h3>\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#top-up-initiated\">\n                                    <h4 class=\"adl-accordion__title\">Top-up initiated<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"bash\",\"tabTitle\":\"\",\"content\":\"\\n{\\n   \\\"data\\\": {\\n       \\\"accountHolder\\\": {\\n           \\\"id\\\": \\\"AH00000000000000000000001\\\"\\n       },\\n       \\\"amount\\\": {\\n           \\\"currency\\\": \\\"EUR\\\",\\n           \\\"value\\\": 100000\\n       },\\n       \\\"balanceAccount\\\": {\\n           \\\"id\\\": \\\"BA00000000000000000000001\\\"\\n       },\\n       \\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n       \\\"balances\\\": [\\n           {\\n               \\\"currency\\\": \\\"EUR\\\",\\n               \\\"received\\\": 100000\\n           }\\n       ],\\n       \\\"category\\\": \\\"bank\\\",\\n       \\\"categoryData\\\": {\\n           \\\"priority\\\": \\\"regular\\\",\\n           \\\"type\\\": \\\"bank\\\"\\n       },\\n       \\\"counterparty\\\": {\\n           \\\"transferInstrumentId\\\": \\\"SE00000000000000000000001\\\"\\n       },\\n       \\\"creationDate\\\": \\\"2023-02-28T13:30:05+02:00\\\",\\n       \\\"direction\\\": \\\"outgoing\\\",\\n       \\\"directDebitInformation\\\": {\\n           \\\"dateOfSignature\\\": \\\"2023-01-01T01:00:00+01:00\\\",\\n           \\\"dueDate\\\": \\\"2024-08-23T02:00:00+02:00\\\",\\n           \\\"mandateId\\\": \\\"EBAClearing-MANDAT001\\\",\\n           \\\"sequenceType\\\": \\\"FRST\\\"\\n       },\\n       \\\"events\\\": [\\n           {\\n               \\\"bookingDate\\\": \\\"2023-02-28T13:30:18+02:00\\\",\\n               \\\"id\\\": \\\"EVJN00000000000000000000000001\\\",\\n               \\\"mutations\\\": [\\n                   {\\n                       \\\"currency\\\": \\\"EUR\\\",\\n                       \\\"received\\\": 100000\\n                   }\\n               ],\\n               \\\"status\\\": \\\"received\\\",\\n               \\\"type\\\": \\\"accounting\\\"\\n           }\\n       ],\\n       \\\"id\\\": \\\"JN4227222422265\\\",\\n       \\\"reason\\\": \\\"approved\\\",\\n       \\\"sequenceNumber\\\": 1,\\n       \\\"status\\\": \\\"received\\\",\\n       \\\"transactionRulesResult\\\": {\\n         \\\"allHardBlockRulesPassed\\\": true\\n       },\\n       \\\"type\\\": \\\"bankDirectDebit\\\",\\n       \\\"ultimateParty\\\": {\\n           \\\"type\\\": \\\"unknown\\\",\\n           \\\"fullName\\\": \\\"***\\\",\\n           \\\"useAsParty\\\": false\\n       }\\n   },\\n   \\\"environment\\\": \\\"test\\\",\\n   \\\"type\\\": \\\"balancePlatform.transfer.created\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#top-up-authorized\">\n                                    <h4 class=\"adl-accordion__title\">Top-up authorized<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"bash\",\"tabTitle\":\"\",\"content\":\"\\n{\\n\\t\\\"data\\\": {\\n\\t\\t\\\"accountHolder\\\": {\\n\\t\\t\\t\\\"id\\\": \\\"AH00000000000000000000001\\\"\\n\\t\\t},\\n\\t\\t\\\"amount\\\": {\\n\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\\"value\\\": 100000\\n\\t\\t},\\n\\t\\t\\\"balanceAccount\\\": {\\n\\t\\t\\t\\\"id\\\": \\\"BA00000000000000000000001\\\"\\n\\t\\t},\\n\\t\\t\\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n\\t\\t\\\"balances\\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\\"received\\\": 0,\\n\\t\\t\\t\\t\\\"reserved\\\": 100000\\n\\t\\t\\t}\\n\\t\\t],\\n\\t\\t\\\"category\\\": \\\"bank\\\",\\n       \\\"categoryData\\\": {\\n           \\\"priority\\\": \\\"regular\\\",\\n           \\\"type\\\": \\\"bank\\\"\\n       },\\n\\t\\t\\\"counterparty\\\": {\\n\\t\\t\\t\\\"transferInstrumentId\\\": \\\"SE00000000000000000000001\\\"\\n\\t\\t},\\n\\t\\t\\\"creationDate\\\": \\\"2023-02-28T13:30:05+02:00\\\",\\n\\t\\t\\\"direction\\\": \\\"outgoing\\\",\\n       \\\"directDebitInformation\\\": {\\n           \\\"dateOfSignature\\\": \\\"2023-01-01T01:00:00+01:00\\\",\\n           \\\"dueDate\\\": \\\"2024-08-23T02:00:00+02:00\\\",\\n           \\\"mandateId\\\": \\\"EBAClearing-MANDAT001\\\",\\n           \\\"sequenceType\\\": \\\"FRST\\\"\\n       },\\n\\t\\t\\\"events\\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"bookingDate\\\": \\\"2023-02-28T13:30:18+02:00\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"EVJN00000000000000000000000001\\\",\\n\\t\\t\\t\\t\\\"mutations\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\t\\\"received\\\": 100000\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"status\\\": \\\"received\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"accounting\\\"\\n\\t\\t\\t},\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"bookingDate\\\": \\\"2023-02-28T13:30:18+02:00\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"EVJN00000000000000000000000002\\\",\\n\\t\\t\\t\\t\\\"mutations\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\t\\\"received\\\": -100000,\\n\\t\\t\\t\\t\\t\\t\\\"reserved\\\": 100000\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"status\\\": \\\"authorised\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"accounting\\\"\\n\\t\\t\\t}\\n\\t\\t],\\n\\t\\t\\\"id\\\": \\\"JN4227222422265\\\",\\n\\t\\t\\\"reason\\\": \\\"approved\\\",\\n\\t\\t\\\"sequenceNumber\\\": 2,\\n\\t\\t\\\"status\\\": \\\"authorised\\\",\\n\\t\\t\\\"transactionRulesResult\\\": {\\n         \\\"allHardBlockRulesPassed\\\": true\\n       },\\n       \\\"type\\\": \\\"bankDirectDebit\\\",\\n       \\\"ultimateParty\\\": {\\n           \\\"type\\\": \\\"unknown\\\",\\n           \\\"fullName\\\": \\\"***\\\",\\n           \\\"useAsParty\\\": false\\n       }\\n\\t},\\n\\t\\\"environment\\\": \\\"test\\\",\\n\\t\\\"type\\\": \\\"balancePlatform.transfer.updated\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#top-up-booked\">\n                                    <h4 class=\"adl-accordion__title\">Top-up booked<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"''\" :code-data='[{\"language\":\"bash\",\"tabTitle\":\"\",\"content\":\"\\n{\\n\\t\\\"data\\\": {\\n\\t\\t\\\"accountHolder\\\": {\\n\\t\\t\\t\\\"id\\\": \\\"AH00000000000000000000001\\\"\\n\\t\\t},\\n\\t\\t\\\"amount\\\": {\\n\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\\"value\\\": 100000\\n\\t\\t},\\n\\t\\t\\\"balanceAccount\\\": {\\n\\t\\t\\t\\\"id\\\": \\\"BA00000000000000000000001\\\"\\n\\t\\t},\\n\\t\\t\\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n\\t\\t\\\"balances\\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"balance\\\": 100000,\\n\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\\"received\\\": 0,\\n\\t\\t\\t\\t\\\"reserved\\\": 0\\n\\t\\t\\t}\\n\\t\\t],\\n\\t\\t\\\"category\\\": \\\"bank\\\",\\n       \\\"categoryData\\\": {\\n           \\\"priority\\\": \\\"regular\\\",\\n           \\\"type\\\": \\\"bank\\\"\\n       },\\n\\t\\t\\\"counterparty\\\": {\\n\\t\\t\\t\\\"transferInstrumentId\\\": \\\"SE00000000000000000000001\\\"\\n\\t\\t},\\n\\t\\t\\\"creationDate\\\": \\\"2023-02-28T13:30:05+02:00\\\",\\n\\t\\t\\\"direction\\\": \\\"incoming\\\",\\n\\t\\t\\\"events\\\": [\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"bookingDate\\\": \\\"2023-02-28T13:30:18+02:00\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"EVJN00000000000000000000000001\\\",\\n\\t\\t\\t\\t\\\"mutations\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\t\\\"received\\\": 100000\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"status\\\": \\\"received\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"accounting\\\"\\n\\t\\t\\t},\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"bookingDate\\\": \\\"2023-02-28T13:30:18+02:00\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"EVJN00000000000000000000000002\\\",\\n\\t\\t\\t\\t\\\"mutations\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\t\\\"received\\\": -100000,\\n\\t\\t\\t\\t\\t\\t\\\"reserved\\\": 100000\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"status\\\": \\\"authorised\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"accounting\\\"\\n\\t\\t\\t},\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"bookingDate\\\": \\\"2023-02-28T13:30:20+02:00\\\",\\n\\t\\t\\t\\t\\\"id\\\": \\\"EVJN00000000000000000000000003\\\",\\n\\t\\t\\t\\t\\\"mutations\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"balance\\\": 100000,\\n\\t\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\t\\\"received\\\": 0,\\n\\t\\t\\t\\t\\t\\t\\\"reserved\\\": -100000\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"status\\\": \\\"booked\\\",\\n\\t\\t\\t\\t\\\"transactionId\\\": \\\"EVJN42272224222B5JB8BRC84N686ZEUR\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"accounting\\\",\\n\\t\\t\\t\\t\\\"valueDate\\\": \\\"2023-03-01T00:00:00+02:00\\\"\\n\\t\\t\\t}\\n\\t\\t],\\n\\t\\t\\\"id\\\": \\\"JN4227222422265\\\",\\n\\t\\t\\\"reason\\\": \\\"approved\\\",\\n\\t\\t\\\"sequenceNumber\\\": 3,\\n\\t\\t\\\"status\\\": \\\"booked\\\",\\n\\t\\t\\\"type\\\": \\\"bankDirectDebit\\\"\\n\\t},\\n\\t\\\"environment\\\": \\\"test\\\",\\n\\t\\\"type\\\": \\\"balancePlatform.transfer.updated\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<h2>Transfer failure examples<\/h2>\n<p>A transfer can fail during processing even if the initial API request is accepted. When a transfer cannot be completed, the status of the transfer is updated, and a <code>balancePlatform.transfer.updated<\/code> notification is sent. Use the following examples to identify the reasons for these failures.<\/p>\n<p>In the following example, a transfer is rejected if it fails internal validation or transaction rules before it can be finalized.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Rejected'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;\\n{\\n   \\&quot;data\\&quot;: {\\n       \\&quot;accountHolder\\&quot;: {\\n           \\&quot;description\\&quot;: \\&quot;Your description of the account holder\\&quot;,\\n           \\&quot;id\\&quot;: \\&quot;AH00000000000000000000002\\&quot;,\\n           \\&quot;reference\\&quot;: \\&quot;Your reference for the account holder\\&quot;\\n       },\\n       \\&quot;amount\\&quot;: {\\n           \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n           \\&quot;value\\&quot;: 1000\\n       },\\n       \\&quot;balanceAccount\\&quot;: {\\n           \\&quot;description\\&quot;: \\&quot;Your description of the target balance account\\&quot;,\\n           \\&quot;id\\&quot;: \\&quot;BA00000000000000000000002\\&quot;\\n       },\\n       \\&quot;balancePlatform\\&quot;: \\&quot;YOUR_BALANCE_PLATFORM\\&quot;,\\n       \\&quot;balances\\&quot;: [\\n           {\\n               \\&quot;balance\\&quot;: -1000,\\n               \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n               \\&quot;received\\&quot;: 0,\\n               \\&quot;reserved\\&quot;: 0\\n           }\\n       ],\\n       \\&quot;category\\&quot;: \\&quot;bank\\&quot;,\\n       \\&quot;categoryData\\&quot;: {\\n           \\&quot;type\\&quot;: \\&quot;bank\\&quot;\\n       },\\n       \\&quot;counterparty\\&quot;: {\\n           \\&quot;bankAccount\\&quot;: {\\n               \\&quot;accountHolder\\&quot;: {\\n                   \\&quot;fullName\\&quot;: \\&quot;John Smith\\&quot;,\\n                   \\&quot;type\\&quot;: \\&quot;unknown\\&quot;\\n               },\\n               \\&quot;accountIdentification\\&quot;: {\\n                   \\&quot;iban\\&quot;: \\&quot;FR0000000000000000000000117\\&quot;,\\n                   \\&quot;type\\&quot;: \\&quot;iban\\&quot;\\n               }\\n           }\\n       },\\n       \\&quot;creationDate\\&quot;: \\&quot;2024-08-28T13:30:05+02:00\\&quot;,\\n       \\&quot;directDebitInformation\\&quot;: {\\n           \\&quot;dateOfSignature\\&quot;: \\&quot;2023-01-01T01:00:00+01:00\\&quot;,\\n           \\&quot;dueDate\\&quot;: \\&quot;2024-08-23T02:00:00+02:00\\&quot;,\\n           \\&quot;mandateId\\&quot;: \\&quot;EBAClearing-MANDAT001\\&quot;,\\n           \\&quot;sequenceType\\&quot;: \\&quot;FRST\\&quot;\\n       },\\n       \\&quot;direction\\&quot;: \\&quot;incoming\\&quot;,\\n       \\&quot;events\\&quot;: [\\n           {\\n               \\&quot;bookingDate\\&quot;: \\&quot;2024-08-28T13:30:18+02:00\\&quot;,\\n               \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000001\\&quot;,\\n               \\&quot;mutations\\&quot;: [\\n                   {\\n                       \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                       \\&quot;received\\&quot;: -1000\\n                   }\\n               ],\\n               \\&quot;status\\&quot;: \\&quot;received\\&quot;,\\n               \\&quot;type\\&quot;: \\&quot;accounting\\&quot;\\n           },\\n           {\\n               \\&quot;bookingDate\\&quot;: \\&quot;2024-08-28T13:30:18+02:00\\&quot;,\\n               \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000002\\&quot;,\\n               \\&quot;mutations\\&quot;: [\\n                   {\\n                       \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                       \\&quot;received\\&quot;: 1000,\\n                       \\&quot;reserved\\&quot;: -1000\\n                   }\\n               ],\\n               \\&quot;status\\&quot;: \\&quot;authorised\\&quot;,\\n               \\&quot;type\\&quot;: \\&quot;accounting\\&quot;\\n           },\\n           {\\n               \\&quot;bookingDate\\&quot;: \\&quot;2024-08-28T13:30:18+02:00\\&quot;,\\n               \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000003\\&quot;,\\n               \\&quot;mutations\\&quot;: [\\n                   {\\n                       \\&quot;balance\\&quot;: -1000,\\n                       \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                       \\&quot;received\\&quot;: 0,\\n                       \\&quot;reserved\\&quot;: 1000\\n                   }\\n               ],\\n               \\&quot;status\\&quot;: \\&quot;booked\\&quot;,\\n               \\&quot;transactionId\\&quot;: \\&quot;JDRF00000000000000000000000MEUR\\&quot;,\\n               \\&quot;type\\&quot;: \\&quot;accounting\\&quot;,\\n               \\&quot;valueDate\\&quot;: \\&quot;2024-08-28T14:00:00+02:00\\&quot;\\n           },\\n           {\\n               \\&quot;bookingDate\\&quot;: \\&quot;2024-09-12T10:25:12+02:00\\&quot;,\\n               \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000004\\&quot;,\\n               \\&quot;mutations\\&quot;: [\\n                   {\\n                       \\&quot;balance\\&quot;: 1000,\\n                       \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                       \\&quot;received\\&quot;: 0,\\n                       \\&quot;reserved\\&quot;: -1000\\n                   }\\n               ],\\n               \\&quot;status\\&quot;: \\&quot;rejected\\&quot;,\\n               \\&quot;transactionId\\&quot;: \\&quot;JDRF00000000000000000000000MEUR\\&quot;,\\n               \\&quot;type\\&quot;: \\&quot;accounting\\&quot;,\\n               \\&quot;valueDate\\&quot;: \\&quot;2024-09-12T14:00:00+02:00\\&quot;\\n           }\\n       ],\\n       \\&quot;id\\&quot;: \\&quot;2WT1N05XXY7P9XH9\\&quot;,\\n       \\&quot;paymentInstrument\\&quot;: {\\n           \\&quot;description\\&quot;: \\&quot;Your reference for the payment instrument\\&quot;,\\n           \\&quot;id\\&quot;: \\&quot;PI00000000000000000000001\\&quot;\\n       },\\n       \\&quot;reason\\&quot;: \\&quot;approved\\&quot;,\\n       \\&quot;reference\\&quot;: \\&quot;Your reference for the transfer\\&quot;,\\n       \\&quot;referenceForBeneficiary\\&quot;: \\&quot;The sender's reference for the beneficiary\\&quot;,\\n       \\&quot;sequenceNumber\\&quot;: 3,\\n       \\&quot;status\\&quot;: \\&quot;rejected\\&quot;,\\n       \\&quot;transactionRulesResult\\&quot;: {\\n           \\&quot;allHardBlockRulesPassed\\&quot;: true\\n       },\\n       \\&quot;type\\&quot;: \\&quot;bankDirectDebit\\&quot;\\n   },\\n   \\&quot;environment\\&quot;: \\&quot;test\\&quot;,\\n   \\&quot;timestamp\\&quot;: \\&quot;2024-08-28T13:27:05+02:00\\&quot;,\\n   \\&quot;type\\&quot;: \\&quot;balancePlatform.transfer.updated\\&quot;\\n}&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>In the following example, a transfer is marked as returned when the funds reach the destination bank but are sent back, usually due to a closed account or incorrect beneficiary details.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Returned'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\\n    \\&quot;data\\&quot;: {\\n        \\&quot;accountHolder\\&quot;: {\\n            \\&quot;description\\&quot;: \\&quot;Your description of the account holder\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;AH00000000000000000000002\\&quot;,\\n            \\&quot;reference\\&quot;: \\&quot;Your reference for the account holder\\&quot;\\n        },\\n        \\&quot;amount\\&quot;: {\\n            \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n            \\&quot;value\\&quot;: 1000\\n        },\\n        \\&quot;balanceAccount\\&quot;: {\\n            \\&quot;description\\&quot;: \\&quot;Your description of the target balance account\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;BA00000000000000000000002\\&quot;\\n        },\\n        \\&quot;balancePlatform\\&quot;: \\&quot;YOUR_BALANCE_PLATFORM\\&quot;,\\n        \\&quot;balances\\&quot;: [\\n            {\\n                \\&quot;balance\\&quot;: -1000,\\n                \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                \\&quot;received\\&quot;: 0,\\n                \\&quot;reserved\\&quot;: 0\\n            }\\n        ],\\n        \\&quot;category\\&quot;: \\&quot;bank\\&quot;,\\n        \\&quot;categoryData\\&quot;: {\\n            \\&quot;type\\&quot;: \\&quot;bank\\&quot;\\n        },\\n        \\&quot;counterparty\\&quot;: {\\n            \\&quot;bankAccount\\&quot;: {\\n                \\&quot;accountHolder\\&quot;: {\\n                    \\&quot;fullName\\&quot;: \\&quot;John Smith\\&quot;,\\n                    \\&quot;type\\&quot;: \\&quot;unknown\\&quot;\\n                },\\n                \\&quot;accountIdentification\\&quot;: {\\n                    \\&quot;iban\\&quot;: \\&quot;FR0000000000000000000000117\\&quot;,\\n                    \\&quot;type\\&quot;: \\&quot;iban\\&quot;\\n                }\\n            }\\n        },\\n        \\&quot;creationDate\\&quot;: \\&quot;2024-08-28T13:30:05+02:00\\&quot;,\\n        \\&quot;directDebitInformation\\&quot;: {\\n            \\&quot;dateOfSignature\\&quot;: \\&quot;2023-01-01T01:00:00+01:00\\&quot;,\\n            \\&quot;dueDate\\&quot;: \\&quot;2024-08-23T02:00:00+02:00\\&quot;,\\n            \\&quot;mandateId\\&quot;: \\&quot;EBAClearing-MANDAT001\\&quot;,\\n            \\&quot;sequenceType\\&quot;: \\&quot;FRST\\&quot;\\n        },\\n        \\&quot;direction\\&quot;: \\&quot;incoming\\&quot;,\\n        \\&quot;events\\&quot;: [\\n            {\\n                \\&quot;bookingDate\\&quot;: \\&quot;2024-08-28T13:30:18+02:00\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000001\\&quot;,\\n                \\&quot;mutations\\&quot;: [\\n                    {\\n                        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                        \\&quot;received\\&quot;: -1000\\n                    }\\n                ],\\n                \\&quot;status\\&quot;: \\&quot;received\\&quot;,\\n                \\&quot;type\\&quot;: \\&quot;accounting\\&quot;\\n            },\\n            {\\n                \\&quot;bookingDate\\&quot;: \\&quot;2024-08-28T13:30:18+02:00\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000002\\&quot;,\\n                \\&quot;mutations\\&quot;: [\\n                    {\\n                        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                        \\&quot;received\\&quot;: 1000,\\n                        \\&quot;reserved\\&quot;: -1000\\n                    }\\n                ],\\n                \\&quot;status\\&quot;: \\&quot;authorised\\&quot;,\\n                \\&quot;type\\&quot;: \\&quot;accounting\\&quot;\\n            },\\n            {\\n                \\&quot;bookingDate\\&quot;: \\&quot;2024-08-28T13:30:18+02:00\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000003\\&quot;,\\n                \\&quot;mutations\\&quot;: [\\n                    {\\n                        \\&quot;balance\\&quot;: -1000,\\n                        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                        \\&quot;received\\&quot;: 0,\\n                        \\&quot;reserved\\&quot;: 1000\\n                    }\\n                ],\\n                \\&quot;status\\&quot;: \\&quot;booked\\&quot;,\\n                \\&quot;transactionId\\&quot;: \\&quot;JDRF00000000000000000000000MEUR\\&quot;,\\n                \\&quot;type\\&quot;: \\&quot;accounting\\&quot;,\\n                \\&quot;valueDate\\&quot;: \\&quot;2024-08-28T14:00:00+02:00\\&quot;\\n            },\\n            {\\n                \\&quot;bookingDate\\&quot;: \\&quot;2024-09-12T10:25:12+02:00\\&quot;,\\n                \\&quot;id\\&quot;: \\&quot;JDRF00000000000000000000000004\\&quot;,\\n                \\&quot;mutations\\&quot;: [\\n                    {\\n                        \\&quot;balance\\&quot;: 1000,\\n                        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n                        \\&quot;received\\&quot;: 0,\\n                        \\&quot;reserved\\&quot;: -1000\\n                    }\\n                ],\\n                \\&quot;status\\&quot;: \\&quot;returned\\&quot;,\\n                \\&quot;transactionId\\&quot;: \\&quot;JDRF00000000000000000000000MEUR\\&quot;,\\n                \\&quot;type\\&quot;: \\&quot;accounting\\&quot;,\\n                \\&quot;valueDate\\&quot;: \\&quot;2024-09-12T14:00:00+02:00\\&quot;\\n            }\\n        ],\\n        \\&quot;id\\&quot;: \\&quot;2WT1N05XXY7P9XH9\\&quot;,\\n        \\&quot;paymentInstrument\\&quot;: {\\n            \\&quot;description\\&quot;: \\&quot;Your reference for the payment instrument\\&quot;,\\n            \\&quot;id\\&quot;: \\&quot;PI00000000000000000000001\\&quot;\\n        },\\n        \\&quot;reason\\&quot;: \\&quot;approved\\&quot;,\\n        \\&quot;reference\\&quot;: \\&quot;Your reference for the transfer\\&quot;,\\n        \\&quot;referenceForBeneficiary\\&quot;: \\&quot;The sender's reference for the beneficiary\\&quot;,\\n        \\&quot;sequenceNumber\\&quot;: 3,\\n        \\&quot;status\\&quot;: \\&quot;returned\\&quot;,\\n        \\&quot;transactionRulesResult\\&quot;: {\\n            \\&quot;allHardBlockRulesPassed\\&quot;: true\\n        },\\n        \\&quot;type\\&quot;: \\&quot;bankDirectDebit\\&quot;\\n    },\\n    \\&quot;environment\\&quot;: \\&quot;test\\&quot;,\\n    \\&quot;timestamp\\&quot;: \\&quot;2024-08-28T13:27:05+02:00\\&quot;,\\n    \\&quot;type\\&quot;: \\&quot;balancePlatform.transfer.updated\\&quot;\\n}&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>Transaction webhooks<\/h2>\n<p>The transaction webhook  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/post\/balancePlatform.transaction.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transaction.created<\/a> informs your server that Adyen has credited funds to your balance account.<\/p>\n<p> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transaction webhooks<\/a> can be used in combination with  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfer webhooks<\/a> to stay fully up to date about the status of your transfers. While a transfer webhook is sent for every status change, transaction webhooks are only sent when the funds from the transfer are credited to the balance account.<\/p>\n<p>Here is an example of a transaction webhook you receive when a top-up is credited to your balance account:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Transaction created for top-up'\" :id=\"''\" :code-data='[{\"language\":\"bash\",\"tabTitle\":\"\",\"content\":\"\\n{\\n\\t\\\"data\\\": {\\n\\t\\t\\\"id\\\": \\\"EVJN00000000000000000000000002EUR\\\",\\n\\t\\t\\\"amount\\\": {\\n\\t\\t\\t\\\"value\\\": 100000,\\n\\t\\t\\t\\\"currency\\\": \\\"EUR\\\"\\n\\t\\t},\\n\\t\\t\\\"status\\\": \\\"booked\\\",\\n\\t\\t\\\"transfer\\\": {\\n\\t\\t\\t\\\"categoryData\\\": {\\n\\t\\t\\t\\t\\\"priority\\\": \\\"regular\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"bank\\\"\\n\\t\\t\\t},\\n\\t\\t\\t\\\"id\\\": \\\"3JNC3O5ZVFLLGV4B\\\",\\n\\t\\t\\t\\\"reference\\\": \\\"automatically-generated-reference\\\"\\n\\t\\t},\\n\\t\\t\\\"valueDate\\\": \\\"2023-08-11T16:19:35+02:00\\\",\\n\\t\\t\\\"bookingDate\\\": \\\"2023-08-11T16:19:45+02:00\\\",\\n\\t\\t\\\"creationDate\\\": \\\"2023-08-11T16:19:35+02:00\\\",\\n\\t\\t\\\"accountHolder\\\": {\\n\\t\\t\\t\\\"id\\\": \\\"AH00000000000000000000001\\\",\\n\\t\\t\\t\\\"description\\\": \\\"Your description for the account holder\\\",\\n\\t\\t\\t\\\"reference\\\": \\\"Your reference for the account holder\\\"\\n\\t\\t},\\n\\t\\t\\\"balanceAccount\\\": {\\n\\t\\t\\t\\\"id\\\": \\\"BA00000000000000000000001\\\",\\n\\t\\t\\t\\\"description\\\": \\\"Your description for the balance account\\\"\\n\\t\\t},\\n\\t\\t\\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\"\\n\\t},\\n\\t\\\"type\\\": \\\"balancePlatform.transaction.created\\\",\\n\\t\\\"environment\\\": \\\"test\\\"\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>See also<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/issuing\/add-manage-funds\/funds-transfers\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Funds transfers<\/h6><p>Transfer funds internally to balance accounts.<\/p><\/div><\/p><\/a><a href=\"\/issuing\/add-manage-funds\/split-payments\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><p class=\"next-steps__body\"><div style=\"text-align: center;\"><h6 class=\"next-steps__title\">Split payments<\/h6><p>Process payments and split the funds between your balance accounts.<\/p><\/div><\/p><\/a><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/issuing\/add-manage-funds\/top-ups\/top-up-webhooks","articleFields":{"Menu":"Top-up webhooks","description":"Stay updated about changes to the recurring top-ups on your platform.","last_edit_on":"11-09-2020 17:20","parameters":{"directoryPath":"\/issuing","integrationType":"issuing"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/issuing\/add-manage-funds\/top-ups\/top-up-webhooks","title":"Top-up webhooks","content":"Managing recurring top-ups using the Top-up API is an asynchronous process. A successful API response does not necessarily indicate that a recurring top-up is successfully created, updated, or deleted.\nTo stay up to date about changes to the recurring top-ups in your platform, we recommend that you subscribe to  Configuration webhooks.\nTo stay up to date about the direct debit triggered by the recurring top-up, we recommend that you subscribe to  Transfer webhooks and  Transaction webhooks.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\n Adyen Issuing integration.  \n\n\nWebhooks\nSubscribe to the following webhook(s):  Configuration webhooks: to stay updated about changes to recurring top-ups in your platform. Transfer webhooks: to stay updated about status changes to the direct debit triggered by the recurring top-up. Transaction webhooks: to stay updated about the movement of funds as a result of a triggered direct debit top-up.\n\n\nSetup steps\nBefore you begin: Make sure that your server can receive and accept webhooks.\n\n\n\nConfiguration webhooks\nTo stay updated about changes to recurring top-ups in your balance platform, you can listen to the following webhooks:\n\nbalancePlatform.balanceAccount.recurringTopUp.created: sent when a new recurring top-up is successfully created.\nbalancePlatform.balanceAccount.recurringTopUp.updated: sent when an existing recurring top-up is successfully updated.\nbalancePlatform.balanceAccount.recurringTopUp.deleted: sent when an existing recurring top-up is successfully deleted.\n\nIn these webhooks, pay attention to the following fields:\n\n\n\nParameter\nDescription\n\n\n\n\naccountId\nThe unique identifier of the balance account on which the recurring top-up is configured.\n\n\nwebhookTopUpConfiguration\nAn object that contains the details of the recurring top-up.\n\n\ntype\nThe type of webhook, indicating whether a recurring top-up is created, updated, or deleted.\n\n\n\nExamples\n\n    \n    \n        \n            \n            \n                                    Recurring top-up created\n                            \n        \n        \n            \n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Recurring top-up updated\n                            \n        \n        \n            \n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Recurring top-up deleted\n                            \n        \n        \n            \n\n    \n\n\n        \n    \n\n\nTransfer webhooks\nWhen a top-up is triggered on your balance platform, Adyen sends the following transfer webhooks:\n\n balancePlatform.transfer.created: which informs your server that an outgoing direct debit request is initiated from a balance account in your balance platform.\n balancePlatform.transfer.updated: which informs your server of the transfer status changes.\n\nIdentify top-up related transfer webhooks\nYou can identify transfer webhooks triggered by payout-related events by looking at the following values:\n\n\n\nParameter\nDescription\nValue\n\n\n\n\ncategory\nThe category of the transfer.\nbank\n\n\ntype\nSpecifies the type of the transfer.\nbankDirectDebit\n\n\n\nExamples\n\n    \n    \n        \n            \n            \n                                    Top-up initiated\n                            \n        \n        \n            \n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Top-up authorized\n                            \n        \n        \n            \n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Top-up booked\n                            \n        \n        \n            \n\n    \n\n\n        \n    \n\n\nTransfer failure examples\nA transfer can fail during processing even if the initial API request is accepted. When a transfer cannot be completed, the status of the transfer is updated, and a balancePlatform.transfer.updated notification is sent. Use the following examples to identify the reasons for these failures.\nIn the following example, a transfer is rejected if it fails internal validation or transaction rules before it can be finalized.\n\n    \n\nIn the following example, a transfer is marked as returned when the funds reach the destination bank but are sent back, usually due to a closed account or incorrect beneficiary details.\n\n    \n\nTransaction webhooks\nThe transaction webhook  balancePlatform.transaction.created informs your server that Adyen has credited funds to your balance account.\n Transaction webhooks can be used in combination with  Transfer webhooks to stay fully up to date about the status of your transfers. While a transfer webhook is sent for every status change, transaction webhooks are only sent when the funds from the transfer are credited to the balance account.\nHere is an example of a transaction webhook you receive when a top-up is credited to your balance account:\n\n    \n\nSee also\n\nFunds transfersTransfer funds internally to balance accounts.Split paymentsProcess payments and split the funds between your balance accounts.\n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Issuing","lvl2":"Add and manage funds","lvl3":"Top up accounts","lvl4":"Top-up webhooks"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/issuing","lvl2":"https:\/\/docs.adyen.com\/pt\/issuing\/add-manage-funds","lvl3":"https:\/\/docs.adyen.com\/pt\/issuing\/add-manage-funds\/top-ups","lvl4":"\/pt\/issuing\/add-manage-funds\/top-ups\/top-up-webhooks"},"levels":5,"category":"Issuing","category_color":"green","tags":["Top-up","webhooks"]}}