{"title":"Get payout status","category":"default","creationDate":1776961629,"content":"<p>If there are any pending changes for the specified payout, the <code>\/getPayoutStatus<\/code> response returns the following:<\/p>\n<ul>\n<li>The original status of the payout. For example, the previous status before the payout was set to pending.\u00a0<\/li>\n<li>The new status requested for the payout. This is the status that is waiting for approval or rejection.<\/li>\n<\/ul>\n<h2 id=\"getpayoutstatus-request-fields\">Request parameters<\/h2>\n<p>To obtain payout status information for a merchant, make a POST <code>\/getPayoutStatus<\/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=\"getpayoutstatus-response-fields\">Response parameters<\/h2>\n<p>The response contains the following information:<\/p>\n<table><thead><tr class=\"header\"><th>Name<\/th><th>Type<\/th><th>Returned\u00a0by\u00a0default<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>\n<p><code>actualState<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><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><td><p>The <em>actual<\/em> status of the payout.<br>\nAllowed values:<\/p><ul><li>\n<p><code>Blocked<\/code><\/p>\n<\/li><li>\n<p><code>Unblocked<\/code><\/p>\n<\/li><\/ul><\/td><\/tr><tr><td>\n<p><code>status<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><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><td><p>The <em>original<\/em> status of the payout, i.e. preceding the pending status.<br>\nAllowed values:<\/p><ul><li>\n<p><code>NonPayable<\/code> (This is always the initial status)<\/p>\n<\/li><li>\n<p><code>Payable<\/code><\/p>\n<\/li><li>\n<p><code>Blocked<\/code><\/p>\n<\/li><\/ul><\/td><\/tr><tr><td>\n<p><code>pendingNewStatus<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td><td><p>The payout status change that has been <em>requested<\/em>, and that is waiting for approval or rejection while the payout is pending.<br>\nAllowed values:<\/p><ul><li>\n<p><code>Payable<\/code><\/p>\n<\/li><li>\n<p><code>Blocked<\/code><\/p>\n<\/li><\/ul><p>When a payout is pending, it is considered blocked.<\/p><\/td><\/tr><tr><td>\n<p><code>jaasUserKey<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td><td>\n<p>String representation of the account user name used to modify the status.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>note<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td><td>When a payout is set to <code>Blocked<\/code>, you can add an explanatory note.<br>\nIf it is populated, the corresponding content is returned here.\u00a0<\/td><\/tr><tr><td>\n<p><code>pspReference<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><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><td>\n<p>A reference to uniquely identify the request.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>warnings<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td><td>\n<p>List containing one or more warning messages.<br \/>\nReturned when the request is not correctly processed.<\/p>\n<\/td><\/tr><tr><td>\n<p><code>errors<\/code><\/p>\n<\/td><td>\n<p>String<\/p>\n<\/td><td>\n<center><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/center>\n<\/td><td>\n<p>List containing one or more error messages.<br \/>\nReturned when the request fails.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n<h2>Examples<\/h2>\n<h3 id=\"request\">Request<\/h3>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"'1911013695'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{  \\n   \\\"merchantCode\\\":\\\"TestMerchant\\\"\\n}\"},{\"language\":\"xml\",\"tabTitle\":\"Soap\",\"content\":\"\\u00a0&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;getPayoutStatus 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;\\\/getPayoutStatus&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=\"'1403032934'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{  \\n   \\\"pspReference\\\":\\\"9914321075110053\\\",\\n   \\\"actualState\\\":\\\"Unblocked\\\",\\n   \\\"jaasUserKey\\\":\\\"ws@Company.TestCompany\\\",\\n   \\\"note\\\":\\\"Updated via API\\\",\\n   \\\"status\\\":\\\"Payable\\\"\\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:getPayoutStatusResponse&gt;\\n      &lt;ns0:response&gt;\\n        &lt;ns0:pspReference&gt;9914321075110053&lt;\\\/ns0:pspReference&gt;\\n        &lt;ns0:actualState&gt;Unblocked&lt;\\\/ns0:actualState&gt;\\n        &lt;ns0:jaasUserKey&gt;ws@Company.TestCompany&lt;\\\/ns0:jaasUserKey&gt;\\n        &lt;ns0:note&gt;Updated via API&lt;\\\/ns0:note&gt;\\n        &lt;ns0:status&gt;Payable&lt;\\\/ns0:status&gt;\\n      &lt;\\\/ns0:response&gt;\\n    &lt;\\\/ns0:getPayoutStatusResponse&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\/getpayoutstatus","articleFields":{"id":"25134986","type":"page","description":"Get the actual payout state at merchant level.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-bank-accounts-and-payouts\/getpayoutstatus","title":"Get payout status","content":"If there are any pending changes for the specified payout, the \/getPayoutStatus response returns the following:\n\nThe original status of the payout. For example, the previous status before the payout was set to pending.\u00a0\nThe new status requested for the payout. This is the status that is waiting for approval or rejection.\n\nRequest parameters\nTo obtain payout status information for a merchant, make a POST \/getPayoutStatus 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\nThe response contains the following information:\nNameTypeReturned\u00a0by\u00a0defaultDescription\nactualState\n\nString\n\n\nThe actual status of the payout.\nAllowed values:\nBlocked\n\nUnblocked\n\nstatus\n\nString\n\n\nThe original status of the payout, i.e. preceding the pending status.\nAllowed values:\nNonPayable (This is always the initial status)\n\nPayable\n\nBlocked\n\npendingNewStatus\n\nString\n\n\nThe payout status change that has been requested, and that is waiting for approval or rejection while the payout is pending.\nAllowed values:\nPayable\n\nBlocked\nWhen a payout is pending, it is considered blocked.\njaasUserKey\n\nString\n\n\n\nString representation of the account user name used to modify the status.\n\nnote\n\nString\n\n\nWhen a payout is set to Blocked, you can add an explanatory note.\nIf it is populated, the corresponding content is returned here.\u00a0\npspReference\n\nString\n\n\n\nA reference to uniquely identify the request.\n\nwarnings\n\nString\n\n\n\nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\nerrors\n\nString\n\n\n\nList containing one or more error messages.\nReturned when the request fails.\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":"Get payout status"},"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\/getpayoutstatus"},"levels":4,"category":"","category_color":"","tags":["payout","status"]},"articleFiles":{"1403032934.json":"<p alt=\"\">1403032934.json<\/p>","1911013695.json":"<p alt=\"\">1911013695.json<\/p>"}}