{"title":"Block a payout","category":"default","creationDate":1776961629,"content":"<p>This operation works at merchant level.<\/p>\n<p>Blocking 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>\/blockPayout<\/code>\u00a0call allows blocking payouts programmatically.  <\/p>\n<p>You can request to block a payout if the following criteria are satisfied:<\/p>\n<ul>\n<li>The payout is in the\u00a0<strong>Payable<\/strong>\u00a0state.<\/li>\n<li>There are no pending changes for the specified payout.\u00a0<\/li>\n<\/ul>\n<h2 id=\"blockpayout-states\">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 block payout for a merchant, make a POST <code>\/blockPayout<\/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=\"'717249075'\" :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;blockPayout 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;\\\/blockPayout&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>\n<h3 id=\"response\">Response<\/h3>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"'1108589630'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{  \\n   \\\"pspReference\\\":\\\"9914526950050204\\\"\\n}\"},{\"language\":\"xml\",\"tabTitle\":\"Soap\",\"content\":\"&lt;?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?&gt;\\n&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\\\" xmlns:ns0=\\\"http:\\\/\\\/caaccount.services.adyen.com\\\"&gt;\\n    &lt;soap:Body&gt;\\n        &lt;ns0:blockPayoutResponse&gt;\\n            &lt;ns0:response&gt;\\n                &lt;ns0:pspReference&gt;9914140758760046&lt;\\\/ns0:pspReference&gt;\\n            &lt;\\\/ns0:response&gt;\\n        &lt;\\\/ns0:blockPayoutResponse&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\/blockpayout","articleFields":{"id":"25134978","type":"page","description":"Block 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\/blockpayout","title":"Block a payout","content":"This operation works at merchant level.\nBlocking payouts usually require a\u00a04-eye policy\u00a0through the\u00a0Adyen Customer Area (CA).\u00a0\nThe\u00a0\/blockPayout\u00a0call allows blocking payouts programmatically.  \nYou can request to block a payout if the following criteria are satisfied:\n\nThe payout is in the\u00a0Payable\u00a0state.\nThere are no pending changes for the specified payout.\u00a0\n\nPayout states\nA payout can go through the following states:\n\nRequest parameters\nTo block payout for a merchant, make a POST \/blockPayout 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":"Block 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\/blockpayout"},"levels":4,"category":"","category_color":"","tags":["Block","payout"]},"articleFiles":{"717249075.json":"<p alt=\"\">717249075.json<\/p>","1108589630.json":"<p alt=\"\">1108589630.json<\/p>"}}
