{"title":"Top up funds in accounts","category":"Classic Platforms","creationDate":1676908380,"content":"<div class=\"sc-notice info\"><div>\n<p>This page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our <a href=\"\/pt\/adyen-for-platforms-model\">new integration guide<\/a> instead.<\/p>\n<\/div><\/div>\n<p>While the funds in account holders' accounts usually come from <a href=\"\/pt\/classic-platforms\/processing-payments\">payments<\/a>, you can also let them top up their accounts with direct debit.<\/p>\n<p>Topping up funds in accounts is useful when:<\/p>\n<ul>\n<li>Covering for possible <a href=\"\/pt\/classic-platforms\/reconciliation-use-cases\/build-transactional-ledger#negative-balances\">negative balances<\/a>, caused by refunds and chargebacks.<\/li>\n<li>Debiting costs from bank accounts when account holders' accounts have insufficient funds.<\/li>\n<\/ul>\n<p>Topping up funds is supported for account holders with bank accounts in the EU, the UK, and the US. The direct debit transactions are processed over corresponding standard debit rails of <a href=\"https:\/\/finance.ec.europa.eu\/consumer-finance-and-payments\/payment-services\/single-euro-payments-area-sepa_en\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Single Euro Payments Area (SEPA)<\/a>, <a href=\"https:\/\/www.bacs.co.uk\/pages\/home.aspx\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Bankers' Automated Clearing Services (BACS)<\/a>, and <a href=\"https:\/\/www.nacha.org\/content\/ach-network\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Automated Clearing House (ACH) network<\/a>.<\/p>\n<h2>Requirements<\/h2>\n<p>Make sure to:<\/p>\n<ul>\n<li>Contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to enable direct debits for your platform.<\/li>\n<li>Have the account holder agree to your platform performing direct debits on their bank account.<\/li>\n<li>When using ACH, business and non-profit account holders must contact their bank and request to allow direct debits from Adyen. Otherwise, banks might block the transactions.<br \/>\nThe bank must allow the following Company or Originator IDs: 2638633811, 9263863381, 8263863381, 4263863381, 3263863381, 2263863380.<\/li>\n<\/ul>\n<h2 id=\"direct-debit-request\">Step 1: Make a direct debit request<\/h2>\n<p>To start a direct debit, send a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/debitAccountHolder<\/a> request specifying:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder#request-accountHolderCode\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountHolderCode<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The code of the account holder.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder#request-amount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The total amount to be debited. When debiting from bank accounts in the EU, the maximum amount is EUR&nbsp;500 per transaction.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder#request-bankAccountUUID\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bankAccountUUID<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The identifier of the account holder's bank account from which funds are debited.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder#request-merchantAccount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">merchantAccount<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Your merchant account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder#request-splits\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">splits<\/a><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Array that contains your instructions on how to split the funds between the accounts in your platform. The array must have at least one item.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder#request-description\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">description<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Your description for the transaction, which you can use when <a href=\"#reconciling-direct-debits\">reconciling the direct debit<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Here is an example of making a direct debit request for USD&nbsp;62 split to two accounts: USD&nbsp;60 to the account holder's account and USD&nbsp;2 to your platform's liable account.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Direct debit request'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/cal-test.adyen.com\\\/cal\\\/services\\\/Fund\\\/v6\\\/debitAccountHolder \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n   \\&quot;accountHolderCode\\&quot;: \\&quot;ACCOUNT_HOLDER_CODE\\&quot;,\\n   \\&quot;description\\&quot;: \\&quot;YOUR_DESCRIPTION\\&quot;,\\n   \\&quot;bankAccountUUID\\&quot;: \\&quot;000b81aa-ae7e-4492-aa7e-72b2129dce0c\\&quot;,\\n   \\&quot;amount\\&quot;: {\\n     \\&quot;value\\&quot;: 6200,\\n     \\&quot;currency\\&quot;: \\&quot;USD\\&quot;\\n   },\\n   \\&quot;merchantAccount\\&quot;: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n   \\&quot;splits\\&quot;: [\\n     {\\n       \\&quot;amount\\&quot;: {\\n         \\&quot;value\\&quot;: 6000\\n       },\\n       \\&quot;type\\&quot;: \\&quot;MarketPlace\\&quot;,\\n       \\&quot;account\\&quot;: \\&quot;8535516988037431\\&quot;,\\n       \\&quot;reference\\&quot;: \\&quot;YOUR_SPLIT_REFERENCE_1\\&quot;,\\n     },\\n     {\\n       \\&quot;amount\\&quot;: {\\n         \\&quot;value\\&quot;: 200\\n       },\\n       \\&quot;type\\&quot;: \\&quot;Commission\\&quot;,\\n       \\&quot;reference\\&quot;: \\&quot;YOUR_SPLIT_REFERENCE_2\\&quot;\\n     }\\n   ]\\n }'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Direct debit response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n  \\\"pspReference\\\":\\\"8515681150749298\\\",\\n  \\\"resultCode\\\":\\\"Received\\\",\\n  \\\"accountHolderCode\\\":\\\"ACCOUNT_HOLDER_CODE\\\",\\n  \\\"bankAccountUUID\\\":\\\"000b81aa-ae7e-4492-aa7e-72b2129dce0c\\\",\\n  \\\"merchantReferences\\\":[\\\"YOUR_SPLIT_REFERENCE_1\\\",\\\"YOUR_SPLIT_REFERENCE_2\\\"]\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>Requests using  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/latest\/post\/debitAccountHolder\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/debitAccountHolder<\/a> are processed asynchronously. You'll receive a response acknowledging that we have received your request, but you must listen to notification webhooks to know the result.<\/p>\n<h2 id=\"direct-debit-webhook\">Step 2. Check the direct debit result<\/h2>\n<p>Listen to the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Notification\/latest\/post\/DIRECT_DEBIT_INITIATED\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">DIRECT_DEBIT_INITIATED<\/a> notification webhook and refer to the <code>status.statusCode<\/code> to know the outcome of your request.<\/p>\n<p>This webhook has two possible status codes:<\/p>\n<ul>\n<li><span translate=\"no\"><strong>Initiated<\/strong><\/span>: The direct debit has been initiated. As transactions are processed over standard debit rails of ACH, BACS, or SEPA, the funds settle to the accounts based on standard settlement times. Once settled, the transaction is included in <a href=\"#reconciling-direct-debits\">reports<\/a>.<\/li>\n<li><span translate=\"no\"><strong>Failed<\/strong><\/span>: The direct debit failed. You may receive this notification up to 3 business days after you sent the request. When a direct debit fails, the possible causes are:\n<ul>\n<li>Validation errors, such as the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Fund\/6\/post\/debitAccountHolder#request-bankAccountUUID\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">bankAccountUUID<\/a> does not exist.<\/li>\n<li>The transaction hit direct debit limits. For example, EUR&nbsp;500 per transaction for SEPA.<\/li>\n<li>The account holder failed to allow Adyen's Company or Originator IDs with their bank.<\/li>\n<li>Adyen did not receive the funds.<\/li>\n<li>Insufficient funds, or any other refusal from the bank.<\/li>\n<\/ul><\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Direct debit initiated'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n\\t\\\"eventDate\\\": \\\"2021-02-01T14:19:14-08:00\\\",\\n\\t\\\"eventType\\\": \\\"DIRECT_DEBIT_INITIATED\\\",\\n\\t\\\"live\\\": \\\"false\\\",\\n\\t\\\"pspReference\\\": \\\"8515681150749298\\\",\\n\\t\\\"content\\\": {\\n\\t\\t\\\"accountCode\\\": \\\"8825579787887769\\\",\\n\\t\\t\\\"amount\\\": {\\n\\t\\t\\t\\\"currency\\\": \\\"USD\\\",\\n\\t\\t\\t\\\"value\\\": 6200\\n\\t\\t},\\n\\t\\t\\\"debitInitiationDate\\\": \\\"2021-02-01\\\",\\n\\t\\t\\\"splits\\\": [\\n\\t\\t\\t{\\n                \\\"account\\\": \\\"8535516988037431\\\",\\n\\t\\t\\t\\t\\\"amount\\\": {\\n\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\\"value\\\": 6000\\n\\t\\t\\t\\t},\\n                \\\"reference\\\": \\\"YOUR_SPLIT_REFERENCE_1\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"MarketPlace\\\",\\n\\n\\t\\t\\t},\\n\\t\\t\\t{\\n\\t\\t\\t\\t\\\"amount\\\": {\\n\\t\\t\\t\\t\\t\\\"currency\\\": \\\"EUR\\\",\\n\\t\\t\\t\\t\\t\\\"value\\\": 200\\n\\t\\t\\t\\t},\\n                \\\"reference\\\": \\\"YOUR_SPLIT_REFERENCE_2\\\",\\n\\t\\t\\t\\t\\\"type\\\": \\\"Commission\\\",\\n\\t\\t\\t}\\n\\t\\t],\\n\\t\\t\\\"status\\\": {\\n\\t\\t\\t\\\"statusCode\\\": \\\"Initiated\\\"\\n\\t\\t}\\n\\t}\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Direct debit failed'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"eventDate\\\": \\\"2021-07-07T16:30:37+02:00\\\",\\n    \\\"eventType\\\": \\\"DIRECT_DEBIT_INITIATED\\\",\\n    \\\"live\\\": \\\"false\\\",\\n    \\\"pspReference\\\": \\\"8315659584588245\\\",\\n    \\\"content\\\": {\\n        \\\"accountCode\\\": \\\"8825579787887769\\\",\\n        \\\"amount\\\": {\\n            \\\"currency\\\": \\\"EUR\\\",\\n            \\\"value\\\": 20000\\n        },\\n        \\\"debitInitiationDate\\\": \\\"2021-07-07\\\",\\n        \\\"merchantAccountCode\\\": \\\"YOUR_MERCHANT_ACCOUNT\\\",\\n        \\\"splits\\\": [\\n            {\\n                \\\"account\\\": \\\"8535516988037431\\\",\\n                \\\"amount\\\": {\\n                    \\\"currency\\\": \\\"EUR\\\",\\n                    \\\"value\\\": 19000\\n                },\\n                \\\"reference\\\": \\\"YOUR_SPLIT_REFERENCE_1\\\",\\n                \\\"type\\\": \\\"MarketPlace\\\"\\n            },\\n            {\\n                \\\"amount\\\": {\\n                    \\\"currency\\\": \\\"EUR\\\",\\n                    \\\"value\\\": 1000\\n                },\\n                \\\"reference\\\": \\\"YOUR_SPLIT_REFERENCE_2\\\",\\n                \\\"type\\\": \\\"Commission\\\"\\n            }\\n        ],\\n        \\\"status\\\": {\\n            \\\"message\\\": {\\n                \\\"code\\\": \\\"10_145\\\",\\n                \\\"text\\\": \\\"Failed to initiate the direct debit for account holder.\\\"\\n            },\\n            \\\"statusCode\\\": \\\"Failed\\\"\\n        }\\n    }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>Reconciling direct debits<\/h2>\n<p>Successful direct debits are settled to your <a href=\"\/pt\/classic-platforms\/account-structure#your-adyen-account\">Adyen merchant account<\/a>. You can see these transactions in the <a href=\"\/pt\/reporting\/settlement-detail-report\">Settlement details report<\/a> with the <code>Record Type<\/code> <span translate=\"no\"><strong>MerchantPayin<\/strong><\/span>.<\/p>\n<p>When funds are credited to the accounts based on split instructions, the credits are reported in the <a href=\"\/pt\/classic-platforms\/reports-and-fees\/marketplace-payments-accounting-report\">Marketplace Payments accounting report<\/a>. Using this report, you can match the direct debits using the <code>description<\/code> you provided in the <code>\/debitAccountHolder<\/code> request. The <code>description<\/code> is included as the <span translate=\"no\"><strong>Payment Merchant Reference<\/strong><\/span>.<\/p>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/classic-platforms\/processing-payments\"\n                        target=\"_self\"\n                        >\n                    Split payments\n                <\/a><\/li><li><a href=\"\/reporting\/settlement-detail-report\"\n                        target=\"_self\"\n                        >\n                    Settlement details report\n                <\/a><\/li><li><a href=\"\/reporting\/settlement-reconciliation\/transaction-level\/marketplace-payments-accounting-report\"\n                        target=\"_self\"\n                        >\n                    Marketplace Payments accounting report\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/top-up-accounts","articleFields":{"description":"Let account holders add funds to their account by debiting directly from their bank account.","search_category":"Classic Platforms","type":"page","last_edit_on":"20-02-2023 16:53","feedback_component":true,"parameters":{"directoryPath":"\/classic-platforms"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/classic-platforms\/top-up-accounts","title":"Top up funds in accounts","content":"\nThis page is for classic Adyen for Platforms integrations. If you are just starting your implementation, refer to our new integration guide instead.\n\nWhile the funds in account holders' accounts usually come from payments, you can also let them top up their accounts with direct debit.\nTopping up funds in accounts is useful when:\n\nCovering for possible negative balances, caused by refunds and chargebacks.\nDebiting costs from bank accounts when account holders' accounts have insufficient funds.\n\nTopping up funds is supported for account holders with bank accounts in the EU, the UK, and the US. The direct debit transactions are processed over corresponding standard debit rails of Single Euro Payments Area (SEPA), Bankers' Automated Clearing Services (BACS), and Automated Clearing House (ACH) network.\nRequirements\nMake sure to:\n\nContact our Support Team to enable direct debits for your platform.\nHave the account holder agree to your platform performing direct debits on their bank account.\nWhen using ACH, business and non-profit account holders must contact their bank and request to allow direct debits from Adyen. Otherwise, banks might block the transactions.\nThe bank must allow the following Company or Originator IDs: 2638633811, 9263863381, 8263863381, 4263863381, 3263863381, 2263863380.\n\nStep 1: Make a direct debit request\nTo start a direct debit, send a POST  \/debitAccountHolder request specifying:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n accountHolderCode\n\nThe code of the account holder.\n\n\n amount\n\nThe total amount to be debited. When debiting from bank accounts in the EU, the maximum amount is EUR&nbsp;500 per transaction.\n\n\n bankAccountUUID\n\nThe identifier of the account holder's bank account from which funds are debited.\n\n\n merchantAccount\n\nYour merchant account.\n\n\n splits\n\nArray that contains your instructions on how to split the funds between the accounts in your platform. The array must have at least one item.\n\n\n description\n\nYour description for the transaction, which you can use when reconciling the direct debit.\n\n\n\nHere is an example of making a direct debit request for USD&nbsp;62 split to two accounts: USD&nbsp;60 to the account holder's account and USD&nbsp;2 to your platform's liable account.\n\n    \n\n\n    \n\nRequests using  \/debitAccountHolder are processed asynchronously. You'll receive a response acknowledging that we have received your request, but you must listen to notification webhooks to know the result.\nStep 2. Check the direct debit result\nListen to the  DIRECT_DEBIT_INITIATED notification webhook and refer to the status.statusCode to know the outcome of your request.\nThis webhook has two possible status codes:\n\nInitiated: The direct debit has been initiated. As transactions are processed over standard debit rails of ACH, BACS, or SEPA, the funds settle to the accounts based on standard settlement times. Once settled, the transaction is included in reports.\nFailed: The direct debit failed. You may receive this notification up to 3 business days after you sent the request. When a direct debit fails, the possible causes are:\n\nValidation errors, such as the  bankAccountUUID does not exist.\nThe transaction hit direct debit limits. For example, EUR&nbsp;500 per transaction for SEPA.\nThe account holder failed to allow Adyen's Company or Originator IDs with their bank.\nAdyen did not receive the funds.\nInsufficient funds, or any other refusal from the bank.\n\n\n\n    \n\n\n    \n\nReconciling direct debits\nSuccessful direct debits are settled to your Adyen merchant account. You can see these transactions in the Settlement details report with the Record Type MerchantPayin.\nWhen funds are credited to the accounts based on split instructions, the credits are reported in the Marketplace Payments accounting report. Using this report, you can match the direct debits using the description you provided in the \/debitAccountHolder request. The description is included as the Payment Merchant Reference.\nSee also\n\n\n                    Split payments\n                \n                    Settlement details report\n                \n                    Marketplace Payments accounting report\n                \n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Classic integration","lvl2":"Top up funds in accounts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/classic-platforms","lvl2":"\/pt\/classic-platforms\/top-up-accounts"},"levels":3,"category":"Classic Platforms","category_color":"green","tags":["funds","accounts"]}}