{"title":"Unblock a payout","category":"default","creationDate":1776961629,"content":"<p>This operation works at merchant level.<\/p>\n<p>Unblocking payouts usually require a\u00a0<a href=\"http:\/\/whatis.techtarget.com\/definition\/four-eyes-principle\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">4-eye policy<\/a>\u00a0through the\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Adyen Customer Area (CA)<\/a>.\u00a0<\/p>\n<p>The\u00a0<code>unblockPayout<\/code>\u00a0call allows unblocking payouts programmatically.<\/p>\n<p>You can request to unblock a payout if the following criteria are satisfied:<\/p>\n<ul>\n<li>The payout is in the\u00a0<strong>Blocked<\/strong>\u00a0state.<\/li>\n<li>There are no pending changes for the specified payout.<\/li>\n<\/ul>\n<div class=\"sc-notice note\"><div>\n<p>This call\u00a0does not support partial updates.<\/p>\n<p> <\/p>\n<p>If an error occurs during an\u00a0update:<\/p>\n<ul>\n<li>No changes are applied.<\/li>\n<li>Current data is kept.<\/li>\n<li>The entire update fails.<\/li>\n<\/ul>\n<\/div><\/div>\n<h2 id=\"unblockpayout-request-fields\">Payout states<\/h2>\n<p>A payout can go through the following states:<\/p>\n<p><img alt=\"\" src=\"\/user\/pages\/reuse\/text-snippet-library\/diagram-payout-states\/diagram-payout-states.png\" \/><\/p>\n<h2 id=\"blockpayout-request-fields\">Request parameters<\/h2>\n<p>To unblock payout, make a POST <code>\/unblockPayout<\/code> request specifying:<\/p>\n<table><thead><tr class=\"header\"><th>Name<\/th><th>Type<\/th><th>Required<\/th><th>Description<\/th><\/tr><\/thead>\n<tbody>\n <tr>\n     <td>\n<p><code>merchantCode<\/code><\/p>\n<\/td>\n     <td>\n<p>String<\/p>\n<\/td>\n     <td>\n<center><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/center>\n<\/td>\n     <td>\n<p>A merchant code string holds a value to identify a merchant.<\/p>\n<p>Format:<\/p>\n<ul>\n<li>Either: <code>MerchantAccount.Merchant_Code<\/code><\/li>\n<li>Or: <code>Merchant_Code<\/code><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n<\/tbody><\/table>\n<h2 id=\"blockpayout-response-fields\">Response parameters<\/h2>\n<p>If there are no errors in the request, the call returns\u00a0a\u00a0<code>pspReference.<\/code>If any issues occur during the process, the call returns one or more warning or error messages.  <\/p>\n<table><thead><tr class=\"header\"><th>Name<\/th><th>Type<\/th><th>Returned\u00a0by\u00a0default<\/th><th>Description<\/th><\/tr><\/thead>\n<tbody>\n  <tr>\n      <td>\n<p><code>pspReference<\/code><\/p>\n<\/td>\n      <td>\n<p>String<\/p>\n<\/td>\n      <td>\n<center><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/center>\n<\/td>\n      <td>\n<p>A reference to uniquely identify the request.<\/p>\n<\/td>\n  <\/tr>\n   <tr>\n       <td>\n<p><code>warnings<\/code><\/p>\n<\/td>\n       <td>\n<p>String<\/p>\n<\/td>\n       <td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td>\n       <td>\n<p>List containing one or more warning messages.<br \/>\nReturned when the request is not correctly processed.<\/p>\n<\/td>\n   <\/tr>\n      <tr>\n          <td>\n<p><code>errors<\/code><\/p>\n<\/td>\n          <td>\n<p>String<\/p>\n<\/td>\n          <td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td>\n          <td>\n<p>List containing one or more error messages.<br \/>\nReturned when the request fails.<\/p>\n<\/td>\n      <\/tr>\n<\/tbody><\/table>\n<h2>Examples<\/h2>\n<h3 id=\"request\">Request<\/h3>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"'421984610'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{  \\n   \\\"merchantCode\\\":\\\"TestMerchant\\\"\\n}\"},{\"language\":\"xml\",\"tabTitle\":\"Soap\",\"content\":\"&lt;soap:Envelope xmlns:soap=\\\"http:\\\/\\\/schemas.xmlsoap.org\\\/soap\\\/envelope\\\/\\\" xmlns:xsd=\\\"http:\\\/\\\/www.w3.org\\\/2001\\\/XMLSchema\\\" xmlns:xsi=\\\"http:\\\/\\\/www.w3.org\\\/2001\\\/XMLSchema-instance\\\"&gt;\\n  &lt;soap:Body&gt;\\n    &lt;unblockPayout xmlns=\\\"http:\\\/\\\/caaccount.services.adyen.com\\\"&gt;\\n      &lt;request&gt;\\n        &lt;merchantCode&gt;TestMerchant&lt;\\\/merchantCode&gt;\\n      &lt;\\\/request&gt;\\n    &lt;\\\/unblockPayout&gt;\\n  &lt;\\\/soap:Body&gt;\\n&lt;\\\/soap:Envelope&gt;\\u00a0\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h3 id=\"response\">Response<\/h3>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"'66588044'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{  \\n   \\\"pspReference\\\":\\\"9914526950210220\\\"\\n}\"},{\"language\":\"xml\",\"tabTitle\":\"Soap\",\"content\":\"&lt;soap:Envelope xmlns:soap=\\\"http:\\\/\\\/schemas.xmlsoap.org\\\/soap\\\/envelope\\\/\\\" xmlns:ns0=\\\"http:\\\/\\\/caaccount.services.adyen.com\\\" xmlns:xsd=\\\"http:\\\/\\\/www.w3.org\\\/2001\\\/XMLSchema\\\" xmlns:xsi=\\\"http:\\\/\\\/www.w3.org\\\/2001\\\/XMLSchema-instance\\\"&gt;\\n  &lt;soap:Body&gt;\\n    &lt;ns0:unblockPayoutResponse&gt;\\n      &lt;ns0:response&gt;\\n        &lt;ns0:pspReference&gt;9914321073950047&lt;\\\/ns0:pspReference&gt;\\n      &lt;\\\/ns0:response&gt;\\n    &lt;\\\/ns0:unblockPayoutResponse&gt;\\n  &lt;\\\/soap:Body&gt;\\n&lt;\\\/soap:Envelope&gt;\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/unblockpayout","articleFields":{"id":"25134982","type":"page","description":"Unblock a payout to\u00a0the merchant's bank account.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/unblockpayout","title":"Unblock a payout","content":"This operation works at merchant level.\nUnblocking payouts usually require a\u00a04-eye policy\u00a0through the\u00a0Adyen Customer Area (CA).\u00a0\nThe\u00a0unblockPayout\u00a0call allows unblocking payouts programmatically.\nYou can request to unblock a payout if the following criteria are satisfied:\n\nThe payout is in the\u00a0Blocked\u00a0state.\nThere are no pending changes for the specified payout.\n\n\nThis call\u00a0does not support partial updates.\n \nIf an error occurs during an\u00a0update:\n\nNo changes are applied.\nCurrent data is kept.\nThe entire update fails.\n\n\nPayout states\nA payout can go through the following states:\n\nRequest parameters\nTo unblock payout, make a POST \/unblockPayout request specifying:\nNameTypeRequiredDescription\n\n \n     \nmerchantCode\n\n     \nString\n\n     \n\n\n     \nA merchant code string holds a value to identify a merchant.\nFormat:\n\nEither: MerchantAccount.Merchant_Code\nOr: Merchant_Code\n\n\n \n\nResponse parameters\nIf there are no errors in the request, the call returns\u00a0a\u00a0pspReference.If any issues occur during the process, the call returns one or more warning or error messages.  \nNameTypeReturned\u00a0by\u00a0defaultDescription\n\n  \n      \npspReference\n\n      \nString\n\n      \n\n\n      \nA reference to uniquely identify the request.\n\n  \n   \n       \nwarnings\n\n       \nString\n\n       \n\n\n       \nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\n   \n      \n          \nerrors\n\n          \nString\n\n          \n\n\n          \nList containing one or more error messages.\nReturned when the request fails.\n\n      \n\nExamples\nRequest\n\n    \n\nResponse\n\n    \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage bank accounts and payouts","lvl3":"Unblock a payout"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/account-management-api","lvl2":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts","lvl3":"\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/unblockpayout"},"levels":4,"category":"","category_color":"","tags":["Unblock","payout"]},"articleFiles":{"66588044.json":"<p alt=\"\">66588044.json<\/p>","421984610.json":"<p alt=\"\">421984610.json<\/p>"}}
