{"title":"Payout webhook","category":"default","creationDate":1776961627,"content":"<div class=\"notices red\">\n<p>We are no longer accepting new integrations with the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Payout\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Payout API<\/a>; 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> instead. With the Transfers API, you can: <ul><li markdown=\"1\">Handle multiple payout use cases with a single API.<\/li><li markdown=\"1\">Use new payout functionalities, such as instant payouts.<\/li><li markdown=\"1\">Receive webhooks with more details and defined transfer states.<\/li><\/ul> If you are:  <br><ul><li markdown=\"1\">Building a new integration, refer to <a href=\"\/pt\/payouts\/payout-service\/webhook-types\/\">Webhook structure and types<\/a> to integrate with the Transfers API.<\/li><li markdown=\"1\">Already integrated with the Payout API, reach out to your Adyen contact for information on how to migrate to the Transfers API.<\/li><\/ul><\/p>\n<\/div>\n<h2>Payouts to bank accounts or wallets<\/h2>\n<p>To know whether a payout to a <a href=\"\/pt\/online-payments\/online-payouts#payouts-to-bank-accounts-and-wallets\">bank account or wallet<\/a> was successful, you need to <a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage#expose-an-endpoint-on-your-server\">set up a webhook<\/a>. The response to a <code>\/submitThirdParty<\/code> request only indicates that the request has been received, not whether the payout was successful.<\/p>\n<p>The following <code>eventCode<\/code>s are important when you make payouts to bank accounts or wallets:<\/p>\n<ul>\n<li>\n<p><strong>PAYOUT_THIRDPARTY<\/strong>: The user reviewing the payout confirmed it. The <code>success<\/code> field indicates whether we received the payout request. Possible values:<\/p>\n<ul>\n<li><code>success<\/code>: <strong>true<\/strong>. We received your payout request, and will send it to the financial institution. When approved, the funds are paid out within 2 business days. In case the financial institution rejects the request, you will receive a webhook event with <code>eventCode<\/code>: <strong>PAIDOUT_REVERSED<\/strong>.<\/li>\n<li><code>success<\/code>: <strong>false<\/strong>. The request failed. The <code>reason<\/code> field includes a short description of the issue. Review the reason, fix the issue if possible, and resubmit the payout request.\n<!-- list separator --><\/li>\n<\/ul>\n<\/li>\n<li>\n<p><strong>PAYOUT_DECLINE<\/strong>: The user reviewing the payout declined it. The <code>success<\/code> field of this webhook event is always set to <strong>true<\/strong>.<\/p>\n<\/li>\n<li>\n<p><strong>PAYOUT_EXPIRE<\/strong>: 7 days have passed since the payout was submitted, and the reviewer has neither confirmed nor declined it. The <code>success<\/code> field of this webhook event is always set to <strong>true<\/strong>.<\/p>\n<\/li>\n<li>\n<p><strong>PAIDOUT_REVERSED<\/strong>: The financial institution rejected the payout. We will return the funds back to your account.<\/p>\n<!-- list separator -->\n<\/li>\n<\/ul>\n<h2>Instant payouts<\/h2>\n<p>When making <a href=\"\/pt\/online-payments\/online-payouts\/instant-payouts\">instant payouts to a card<\/a>, you will get a response to your <code>\/payout<\/code> request with <code>resultCode<\/code>: <strong>Received<\/strong>. For a successful payout, you will then receive a webhook event with:<\/p>\n<ul>\n<li><code>eventCode<\/code>: <strong>PAYOUT_THIRDPARTY<\/strong><\/li>\n<li><code>success<\/code>: <strong>true<\/strong><\/li>\n<\/ul>\n<p>If the issuer refuses the payout, you will receive a webhook event with:<\/p>\n<ul>\n<li><code>eventCode<\/code>: <strong>PAYOUT_THIRDPARTY<\/strong><\/li>\n<li><code>success<\/code>: <strong>false<\/strong><\/li>\n<\/ul>\n<h2 id=\"code-examples\">Code examples<\/h2>\n<p>The following example shows a <strong>PAYOUT_THIRDPARTY<\/strong> webhook event with <code>success<\/code>: <strong>true<\/strong>.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"''\" :id=\"'1804719907'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"JSON\",\"content\":\"{\\n    \\\"live\\\" : \\\"false\\\",\\n    \\\"notificationItems\\\" : [\\n        {\\n            \\\"notificationRequestItem\\\" : {   \\n                \\\"amount\\\" : {\\n                    \\\"value\\\" : 500,\\n                    \\\"currency\\\" : \\\"EUR\\\"\\n                 },\\n                 \\n                \\\"eventCode\\\" : \\\"PAYOUT_THIRDPARTY\\\",\\n                \\\"eventDate\\\" : \\\"2011-01-01T15:30:17.377+02:00\\\",\\n                \\\"merchantAccountCode\\\" : \\\"YourMerchantAccount\\\",\\n                \\\"merchantReference\\\" : \\\"Payout-0001\\\",\\n                \\\"paymentMethod\\\" : \\\"visa\\\",\\n                \\\"pspReference\\\" : \\\"ThePaymentPspReference\\\",\\n                \\\"originalReference\\\" : \\\"ThePayoutPspReference\\\",\\n                \\\"reason\\\" : \\\"Approved\\\",\\n                \\\"success\\\" : \\\"true\\\"\\n            }\\n        }\\n    ]\\n}\"},{\"language\":\"xml\",\"tabTitle\":\"Soap\",\"content\":\"&lt;?xml version=\\\"1.0\\\"?&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\\\"&gt;\\n  &lt;soap:Body&gt;\\n    &lt;ns1:sendNotification xmlns:ns1=\\\"http:\\\/\\\/notification.services.adyen.com\\\"&gt;\\n      &lt;ns1:Notification&gt;\\n        &lt;live xmlns=\\\"http:\\\/\\\/notification.services.adyen.com\\\"&gt;false&lt;\\\/live&gt; \\n        &lt;notificationItems xmlns=\\\"http:\\\/\\\/notification.services.adyen.com\\\"&gt; \\n          &lt;notificationRequestItem&gt; \\n            &lt;amount&gt; \\n              &lt;currency xmlns=\\\"http:\\\/\\\/common.services.adyen.com\\\"&gt;EUR&lt;\\\/currency&gt; \\n              &lt;value xmlns=\\\"http:\\\/\\\/common.services.adyen.com\\\"&gt;500&lt;\\\/value&gt; \\n            &lt;\\\/amount&gt; \\n            &lt;eventCode&gt;PAYOUT_THIRDPARTY&lt;\\\/eventCode&gt;\\n            &lt;eventDate&gt;2011-01-01T15:30:17.377+02:00&lt;\\\/eventDate&gt;\\n            &lt;merchantAccountCode&gt;YourMerchantAccount&lt;\\\/merchantAccountCode&gt;\\n            &lt;merchantReference&gt;Payout-0001&lt;\\\/merchantReference&gt;\\n            &lt;paymentMethod&gt;visa&lt;\\\/paymentMethod&gt;\\n            &lt;pspReference&gt;ThePaymentPspReference&lt;\\\/pspReference&gt;\\n            &lt;originalReference&gt;ThePayoutPspReference&lt;\\\/originalReference&gt;\\n            &lt;reason&gt;Approved&lt;\\\/reason&gt;\\n            &lt;success&gt;true&lt;\\\/success&gt; \\n          &lt;\\\/notificationRequestItem&gt; \\n      &lt;\\\/ns1:Notification&gt;\\n    &lt;\\\/ns1:sendNotification&gt;\\n  &lt;\\\/soap:Body&gt;\\n&lt;\\\/soap:Envelope&gt;\"},{\"language\":\"html\",\"tabTitle\":\"Form\",\"content\":\"originalReference=7914447213528916&amp;reason=&amp;merchantAccountCode=TestMerchant&amp;eventCode=PAYOUT_THIRDPARTY&amp;operations=&amp;success=true&amp;paymentMethod=bankTransfer_NL&amp;currency=EUR&amp;pspReference=7914447213809209&amp;merchantReference=Rest+Noti&amp;value=400&amp;live=false&amp;eventDate=2015-10-13T07%3A29%3A40.00Z\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/online-payments\/online-payouts\/payout-webhook","articleFields":{"description":"Learn about the outcomes of your payout requests.","id":"35196425","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"23-10-2020 15:10","parameters":{"scoped":"true","transfers":"[Webhook structure and types](\/payouts\/payout-service\/webhook-types\/)"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/online-payments\/online-payouts\/payout-webhook","title":"Payout webhook","content":"\nWe are no longer accepting new integrations with the  Payout API; use the  Transfers API instead. With the Transfers API, you can: Handle multiple payout use cases with a single API.Use new payout functionalities, such as instant payouts.Receive webhooks with more details and defined transfer states. If you are:  Building a new integration, refer to Webhook structure and types to integrate with the Transfers API.Already integrated with the Payout API, reach out to your Adyen contact for information on how to migrate to the Transfers API.\n\nPayouts to bank accounts or wallets\nTo know whether a payout to a bank account or wallet was successful, you need to set up a webhook. The response to a \/submitThirdParty request only indicates that the request has been received, not whether the payout was successful.\nThe following eventCodes are important when you make payouts to bank accounts or wallets:\n\n\nPAYOUT_THIRDPARTY: The user reviewing the payout confirmed it. The success field indicates whether we received the payout request. Possible values:\n\nsuccess: true. We received your payout request, and will send it to the financial institution. When approved, the funds are paid out within 2 business days. In case the financial institution rejects the request, you will receive a webhook event with eventCode: PAIDOUT_REVERSED.\nsuccess: false. The request failed. The reason field includes a short description of the issue. Review the reason, fix the issue if possible, and resubmit the payout request.\n\n\n\n\nPAYOUT_DECLINE: The user reviewing the payout declined it. The success field of this webhook event is always set to true.\n\n\nPAYOUT_EXPIRE: 7 days have passed since the payout was submitted, and the reviewer has neither confirmed nor declined it. The success field of this webhook event is always set to true.\n\n\nPAIDOUT_REVERSED: The financial institution rejected the payout. We will return the funds back to your account.\n\n\n\nInstant payouts\nWhen making instant payouts to a card, you will get a response to your \/payout request with resultCode: Received. For a successful payout, you will then receive a webhook event with:\n\neventCode: PAYOUT_THIRDPARTY\nsuccess: true\n\nIf the issuer refuses the payout, you will receive a webhook event with:\n\neventCode: PAYOUT_THIRDPARTY\nsuccess: false\n\nCode examples\nThe following example shows a PAYOUT_THIRDPARTY webhook event with success: true.\n\n    \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Online payouts","lvl3":"Payout webhook"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/online-payments","lvl2":"https:\/\/docs.adyen.com\/pt\/online-payments\/online-payouts","lvl3":"\/pt\/online-payments\/online-payouts\/payout-webhook"},"levels":4,"category":"Online Payments","category_color":"green","tags":["Payout","webhook"]}}