{"title":"Make a cashout request","category":"default","creationDate":1571779920,"content":"<p><span style=\"color: #0ABF53;\"><span style=\"font-size: 20px;\"><strong>Limited availability<\/strong><\/span><\/span><br \/>\nCashouts are in pilot phase. Some of the processes and documentation may change as the feature evolves.<\/p>\n<hr \/>\n<p>When you make a cashout, your user's pending funds are instantly made available in your user's balance account. In your cashout request, you can also specify to pay out the funds to the user's transfer instrument.<\/p>\n<p>To make a cashout request:<\/p>\n<ol>\n<li>(Recommended) <a href=\"#get-pending-balance\">Get the pending balance on the user's balance account<\/a>: Ensure that your user has enough funds for the cashout.<\/li>\n<li><a href=\"#initiate-cashout\">Initiate the cashout<\/a>: Specify the details of the cashout in an API request.<\/li>\n<li><a href=\"#get-updates-webhooks\">Get updates on the status of the cashout<\/a>: Listen to webhooks to check the status of the cashout.<\/li>\n<\/ol>\n<p>The following sections explain how to perform these steps.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you initiate a cashout:<\/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 cashout for your platform.<\/li>\n<li>Ensure that your API credential has <a href=\"\/pt\/platforms\/manage-access\/webservice-roles?tab=transfers_2\">roles<\/a> to use the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a>.<\/li>\n<li>Ensure that the <a href=\"\/pt\/platforms\/settle-funds\">sales day settlement<\/a> is enabled in your user's balance account.<\/li>\n<li>Ensure that your account and your user's account have the <strong>receiveFromBalanceAccount<\/strong> <a href=\"\/pt\/platforms\/verification-overview\/capabilities#business-setup-capabilities\">capability<\/a>.<\/li>\n<li>Ensure that your user's account has the <strong>sendToBalanceAccount<\/strong>.<\/li>\n<li>Ensure that your user's account has the <strong>sendToTransferInstrument<\/strong> . This is only required for cashout requests that include a <code>transferInstrumentId<\/code>.\n<div class=\"notices green\">\n<p>From LEM API v3, this capability is verified at the level of the transfer instrument, such as a bank account. This means that transfers are possible to a verified transfer instrument independently of the verification status of other transfer instruments that the legal entity has.<\/p>\n<\/div><\/li>\n<li>Ensure that your server <a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">receives and accepts webhooks<\/a>.<\/li>\n<\/ul>\n<h2 id=\"get-pending-balance\">(Recommended) Get the pending balance on the balance account<\/h2>\n<p>Before initiating a cashout for a user, we recommend that you get the pending balance on the user's balance account. By doing this, you can:<\/p>\n<ul>\n<li>Show the pending balance to your user, so that they know the maximum amount that they can ask for.<\/li>\n<li>Check that the amount that your user is asking for is less or equal to the pending balance.<\/li>\n<\/ul>\n<p>To get the pending balance on your user's balance account:<\/p>\n<ol>\n<li>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/balanceAccounts\/(id)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balanceAccounts\/{id}<\/a> request.<\/li>\n<li>In the response, note the value of the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/balanceAccounts\/(id)#responses-200-balances-pending\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balances.pending<\/a> parameter.<\/li>\n<\/ol>\n<h2 id=\"initiate-cashout\">Initiate a cashout<\/h2>\n<p>To initiate a cashout, make a POST <code>\/cashouts<\/code> request, specifying the following parameters in the request body:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>instructingBalanceAccountId<\/code><\/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>The unique identifier of the balance account where the cashout amount is settled.<\/td>\n<\/tr>\n<tr>\n<td><code>amount.value<\/code><\/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>The amount of the cashout. This is the amount that is settled and paid out to your user. This value cannot be higher than the pending balance.<\/td>\n<\/tr>\n<tr>\n<td><code>amount.currency<\/code><\/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>The currency of the cashout amount.<\/td>\n<\/tr>\n<tr>\n<td><code>transferInstrumentId<\/code><\/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\" \/><br\/>Required to pay out the funds to the user's transfer instrument.<\/td>\n<td>The unique identifier of the user's  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/post\/transferInstruments\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">transfer instrument<\/a> to which the funds are paid out.<br\/><br\/>If you do not provide this value, the funds are not paid out, but remain in the user's balance account.<\/td>\n<\/tr>\n<tr>\n<td><code>fee.amount.value<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td>The amount (in minor units) of the fee that your platform charges for the cashout. Note that:<br\/><ul><li markdown=\"1\">The fee amount cannot be higher than the cashout amount.<\/li><li markdown=\"1\">The sum of the cashout and fee amounts cannot be higher than the pending balance.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>fee.amount.currency<\/code><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td>The currency of the fee that your platform charges for the cashout. This value must be the same as <code>amount.currency<\/code>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The following example shows a cashout request for EUR&nbsp;1000, with a fee of EUR&nbsp;10.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Initiate a cashout request'\" :id=\"'initiate-cashout'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/v4\\\/cashouts \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST \\\\\\n-d '{\\n    \\&quot;instructingBalanceAccountId\\&quot;: \\&quot;BA00000000000000000000001\\&quot;,\\n    \\&quot;transferInstrumentId\\&quot;: \\&quot;SE00000000000000000000001\\&quot;,\\n    \\&quot;amount\\&quot;: {\\n        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n        \\&quot;value\\&quot;: 100000\\n    },\\n    \\&quot;fee\\&quot;: {\\n        \\&quot;amount\\&quot;:{\\n            \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n            \\&quot;value\\&quot;: 1000\\n        }\\n    }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>The following tabs show the responses that you receive after a successful or failed request.<\/p>\n\n<div id=\"tabmCgWv\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Successful cashout request&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;If the request succeeds, note the following response parameters, which help you identify cashout-related transfers:&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;&lt;div style=\\&quot;width:190px\\&quot;&gt;Response parameter&lt;\\\/div&gt;&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;id&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;The unique identifier of the cashout.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;transfers&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;An array of objects that contain information about the transfers created in relation to the cashout.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;code&gt;transfers.type&lt;\\\/code&gt;&lt;\\\/td&gt;\\n&lt;td&gt;Specifies the type of transfer data that the object contains.&lt;br\\\/&gt;Possible values:&lt;br\\\/&gt;&lt;ul&gt;&lt;li markdown=\\&quot;1\\&quot;&gt;&lt;strong&gt;cashoutRepayment&lt;\\\/strong&gt;: Corresponds to the transfer created to deduct the cashout amount after settlement.&lt;\\\/li&gt;&lt;li markdown=\\&quot;1\\&quot;&gt;&lt;strong&gt;cashoutFee&lt;\\\/strong&gt;: Corresponds to the transfer created to debit the cashout fee form the user&#039;s balance account.&lt;\\\/li&gt;&lt;\\\/ul&gt;&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&lt;p&gt;The following example shows a successful response for a created cashout.&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Response for a created cashout&#039;\\&quot; :id=\\&quot;&#039;cashout-created&#039;\\&quot; :code-data=&#039;[{\\&quot;language\\&quot;:\\&quot;json\\&quot;,\\&quot;tabTitle\\&quot;:\\&quot;\\&quot;,\\&quot;content\\&quot;:\\&quot;{\\\\n    \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;CAOT0000000000000000000000001\\\\\\&quot;,\\\\n    \\\\\\&quot;amount\\\\\\&quot;: {\\\\n        \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;,\\\\n        \\\\\\&quot;value\\\\\\&quot;: 100000\\\\n    },\\\\n    \\\\\\&quot;fee\\\\\\&quot;: {\\\\n        \\\\\\&quot;amount\\\\\\&quot;: {\\\\n            \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;,\\\\n            \\\\\\&quot;value\\\\\\&quot;: 1000\\\\n        }\\\\n    },\\\\n    \\\\\\&quot;instructingBalanceAccountId\\\\\\&quot;: \\\\\\&quot;BA00000000000000000000001\\\\\\&quot;,\\\\n    \\\\\\&quot;transerInstrumentId\\\\\\&quot;: \\\\\\&quot;SE00000000000000000000001\\\\\\&quot;,\\\\n    \\\\\\&quot;transfers\\\\\\&quot;: [\\\\n        {\\\\n            \\\\\\&quot;amount\\\\\\&quot;: {\\\\n                \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;,\\\\n                \\\\\\&quot;value\\\\\\&quot;: 100000\\\\n            },\\\\n            \\\\\\&quot;category\\\\\\&quot;: \\\\\\&quot;internal\\\\\\&quot;,\\\\n            \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;400F6060JMB1I0AB\\\\\\&quot;,\\\\n            \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;cashoutRepayment\\\\\\&quot;\\\\n        },\\\\n        {\\\\n            \\\\\\&quot;amount\\\\\\&quot;: {\\\\n                \\\\\\&quot;currency\\\\\\&quot;: \\\\\\&quot;EUR\\\\\\&quot;,\\\\n                \\\\\\&quot;value\\\\\\&quot;: 1000\\\\n            },\\\\n            \\\\\\&quot;category\\\\\\&quot;: \\\\\\&quot;internal\\\\\\&quot;,\\\\n            \\\\\\&quot;id\\\\\\&quot;: \\\\\\&quot;400F6060JMB1I0AA\\\\\\&quot;,\\\\n            \\\\\\&quot;type\\\\\\&quot;: \\\\\\&quot;cashoutFee\\\\\\&quot;\\\\n        }\\\\n    ]\\\\n}\\&quot;}]&#039; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;After you make the cashout request, Adyen will process it asynchronously. To track any updates related to your cashout request, use the &lt;a href=\\&quot;\\\/pt\\\/platforms\\\/cash-out-instantly\\\/cashout-webhooks\\&quot;&gt;webhooks&lt;\\\/a&gt; that Adyen sends to your server.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;successful_cashout_request_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Failed cashout request&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;If the request fails, you receive an error response with information about the error.&lt;\\\/p&gt;\\n&lt;p&gt;The following table describes some of the errors and messages that you can get when you make cashout requests.&lt;\\\/p&gt;\\n&lt;table style=\\&quot;width: 100%\\&quot;&gt;\\n    &lt;colgroup&gt;\\n        &lt;col span=\\&quot;1\\&quot; style=\\&quot;width: 30%\\&quot;&gt;\\n        &lt;col span=\\&quot;1\\&quot; style=\\&quot;width: 70%\\&quot;&gt;\\n    &lt;\\\/colgroup&gt;\\n    &lt;thead&gt;\\n        &lt;tr&gt;\\n            &lt;th&gt;Error message&lt;\\\/th&gt;\\n            &lt;th&gt;Description&lt;\\\/th&gt;\\n        &lt;\\\/tr&gt;\\n    &lt;\\\/thead&gt;\\n    &lt;tbody&gt;\\n        &lt;tr&gt;\\n            &lt;td&gt;\\n&lt;p&gt;Could not find transfer instrument&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n            &lt;td&gt;The &lt;code&gt;transferInstrumentId&lt;\\\/code&gt; that you specified:\\n                &lt;ul&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;Does not exist.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;Does not belong to the same &lt;a href=\\&quot;\\\/platforms\\\/account-structure-resources\\\/legal-entity-management\\&quot;&gt;legal entity&lt;\\\/a&gt; as the &lt;code&gt;instructingBalanceAccount&lt;\\\/code&gt;.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                &lt;\\\/ul&gt;\\n            &lt;\\\/td&gt;\\n        &lt;\\\/tr&gt;\\n        &lt;tr&gt;\\n            &lt;td&gt;\\n&lt;p&gt;No instant route found for transfer instrument id&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n            &lt;td&gt;\\n                There are no available &lt;a href=\\&quot;\\\/platforms\\\/payout-to-users\\\/transfer-routes\\&quot;&gt;transfer routes&lt;\\\/a&gt; for making an &lt;a href=\\&quot;\\\/platforms\\\/payout-to-users\\\/#transfer-priority\\&quot;&gt;instant payout&lt;\\\/a&gt; to the &lt;code&gt;transferInstrumentId&lt;\\\/code&gt; that you specified. This can happen because, for example:\\n                &lt;ul&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;The counterparty bank is located in a region where Adyen does not support instant payouts.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;The counterparty bank does not accept the currency of the payout.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;Adyen could not reach the counterparty at the moment of the request.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                &lt;\\\/ul&gt;\\n                Note that if you get this error, the cashout request is not processed and the cashout funds are not transferred to your user&#039;s balance account.\\n            &lt;\\\/td&gt;\\n        &lt;\\\/tr&gt;\\n        &lt;tr&gt;\\n            &lt;td&gt;\\n&lt;p&gt;Invalid amount \\\/ Invalid fee amount&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n            &lt;td&gt;\\n&lt;p&gt;This information indicates that Adyen does not support cashout requests in the currency you specified. You can only make cashout requests for EUR, USD, and GBP. For more information, see the &lt;a href=\\&quot;#supported-regions-amounts\\&quot;&gt;supported regions, currencies, and cashout amounts&lt;\\\/a&gt;.&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n        &lt;\\\/tr&gt;\\n        &lt;tr&gt;\\n            &lt;td&gt;\\n&lt;p&gt;Fee amount has a different currency than the instruction amount&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n            &lt;td&gt;\\n&lt;p&gt;This information indicates that the &lt;a href=\\&quot;#initiate-cashout\\&quot;&gt;request parameters&lt;\\\/a&gt; &lt;code&gt;amount.currency&lt;\\\/code&gt; and &lt;code&gt;fee.amount.currency&lt;\\\/code&gt; have different values.&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n        &lt;\\\/tr&gt;\\n        &lt;tr&gt;\\n            &lt;td&gt;\\n&lt;p&gt;Minimum required amount not reached&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n            &lt;td&gt;\\n&lt;p&gt;This information indicates that the cashout amount is less than EUR\\\/USD\\\/GBP 1.&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n        &lt;\\\/tr&gt;\\n        &lt;tr&gt;\\n            &lt;td&gt;\\n&lt;p&gt;Amount exceeds pending balance&lt;\\\/p&gt;\\n&lt;\\\/td&gt;\\n            &lt;td&gt;\\n                This information indicates one of the following:\\n                &lt;ul&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;The cashout amount is higher than the pending balance.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                    &lt;li&gt;\\n&lt;p&gt;The sum of the cashout amount and the fee is higher than the pending balance.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n                &lt;\\\/ul&gt;\\n            &lt;\\\/td&gt;\\n        &lt;\\\/tr&gt;\\n    &lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;failed_cashout_request_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2 id=\"get-updates-webhooks\">Get updates on the status of the cashout<\/h2>\n<p>A cashout involves multiple funds transfers, which you can track by listening to <a href=\"\/pt\/platforms\/cash-out-instantly\/cashout-webhooks\">webhooks<\/a>. Webhooks inform you about any status change in the transfers, and whether the transfers succeed or fail.<\/p>\n<p>Adyen sends three types of webhooks for each transfer:<\/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 funds will be transferred to or from a balance account in your 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 changes in the status of the transfer.<\/li>\n<li> <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>, which informs your server when funds have been debited from or credited to a balance account.<\/li>\n<\/ul>\n<p>To listen to these webhooks:<\/p>\n<ol>\n<li>Ensure that your server can <a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">receive and accept webhooks<\/a>.<\/li>\n<li>Subscribe to <strong>Transfer webhooks<\/strong> and <strong>Transaction webhooks<\/strong> in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<\/ol>\n<p>Alternatively, you can <a href=\"\/pt\/platforms\/view-transfers-details\">view the transfer details in your Customer Area<\/a>.<\/p>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/platforms\/cash-out-instantly\/cashout-webhooks\"\n                        target=\"_self\"\n                        >\n                    Cashout webhooks\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/platforms\/cash-out-instantly\/cashout-request","articleFields":{"description":"Learn how to make a cashout request using Adyen's API.","last_edit_on":"11-09-2020 17:20","cache_enable":false,"parameters":{"payoutType":"on-demand","counterpartyType":"transferInstrument","directoryPath":"\/platforms","model":"platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/platforms\/cash-out-instantly\/cashout-request","title":"Make a cashout request","content":"Limited availability\nCashouts are in pilot phase. Some of the processes and documentation may change as the feature evolves.\n\nWhen you make a cashout, your user's pending funds are instantly made available in your user's balance account. In your cashout request, you can also specify to pay out the funds to the user's transfer instrument.\nTo make a cashout request:\n\n(Recommended) Get the pending balance on the user's balance account: Ensure that your user has enough funds for the cashout.\nInitiate the cashout: Specify the details of the cashout in an API request.\nGet updates on the status of the cashout: Listen to webhooks to check the status of the cashout.\n\nThe following sections explain how to perform these steps.\nRequirements\nBefore you initiate a cashout:\n\nContact our Support Team to enable cashout for your platform.\nEnsure that your API credential has roles to use the  Transfers API.\nEnsure that the sales day settlement is enabled in your user's balance account.\nEnsure that your account and your user's account have the receiveFromBalanceAccount capability.\nEnsure that your user's account has the sendToBalanceAccount.\nEnsure that your user's account has the sendToTransferInstrument . This is only required for cashout requests that include a transferInstrumentId.\n\nFrom LEM API v3, this capability is verified at the level of the transfer instrument, such as a bank account. This means that transfers are possible to a verified transfer instrument independently of the verification status of other transfer instruments that the legal entity has.\n\nEnsure that your server receives and accepts webhooks.\n\n(Recommended) Get the pending balance on the balance account\nBefore initiating a cashout for a user, we recommend that you get the pending balance on the user's balance account. By doing this, you can:\n\nShow the pending balance to your user, so that they know the maximum amount that they can ask for.\nCheck that the amount that your user is asking for is less or equal to the pending balance.\n\nTo get the pending balance on your user's balance account:\n\nMake a GET  \/balanceAccounts\/{id} request.\nIn the response, note the value of the  balances.pending parameter.\n\nInitiate a cashout\nTo initiate a cashout, make a POST \/cashouts request, specifying the following parameters in the request body:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\ninstructingBalanceAccountId\n\nThe unique identifier of the balance account where the cashout amount is settled.\n\n\namount.value\n\nThe amount of the cashout. This is the amount that is settled and paid out to your user. This value cannot be higher than the pending balance.\n\n\namount.currency\n\nThe currency of the cashout amount.\n\n\ntransferInstrumentId\nRequired to pay out the funds to the user's transfer instrument.\nThe unique identifier of the user's  transfer instrument to which the funds are paid out.If you do not provide this value, the funds are not paid out, but remain in the user's balance account.\n\n\nfee.amount.value\n\nThe amount (in minor units) of the fee that your platform charges for the cashout. Note that:The fee amount cannot be higher than the cashout amount.The sum of the cashout and fee amounts cannot be higher than the pending balance.\n\n\nfee.amount.currency\n\nThe currency of the fee that your platform charges for the cashout. This value must be the same as amount.currency.\n\n\n\nThe following example shows a cashout request for EUR&nbsp;1000, with a fee of EUR&nbsp;10.\n\n    \n\nThe following tabs show the responses that you receive after a successful or failed request.\n\n\n    \n        \n        \n    \n\n\nGet updates on the status of the cashout\nA cashout involves multiple funds transfers, which you can track by listening to webhooks. Webhooks inform you about any status change in the transfers, and whether the transfers succeed or fail.\nAdyen sends three types of webhooks for each transfer:\n\n balancePlatform.transfer.created, which informs your server that funds will be transferred to or from a balance account in your platform.\n balancePlatform.transfer.updated, which informs your server of changes in the status of the transfer.\n balancePlatform.transaction.created, which informs your server when funds have been debited from or credited to a balance account.\n\nTo listen to these webhooks:\n\nEnsure that your server can receive and accept webhooks.\nSubscribe to Transfer webhooks and Transaction webhooks in your Customer Area.\n\nAlternatively, you can view the transfer details in your Customer Area.\nSee also\n\n\n                    Cashout webhooks\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Platforms","lvl2":"Cash out pending funds instantly","lvl3":"Make a cashout request"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/platforms","lvl2":"https:\/\/docs.adyen.com\/pt\/platforms\/cash-out-instantly","lvl3":"\/pt\/platforms\/cash-out-instantly\/cashout-request"},"levels":4,"category":"Platforms","category_color":"green","tags":["cashout","request"]}}
