{"title":"Webhook structure and types for payouts","category":"default","creationDate":1574033460,"content":"<p>On this page, you'll find information about:<\/p>\n<ul>\n<li>The general <a href=\"#webhook-structure\">webhook structure<\/a>.<\/li>\n<li>The <a href=\"#type\">types of webhooks<\/a>.<\/li>\n<\/ul>\n<p>You'll also learn about which webhook types are sent based on which event.<\/p>\n<h2 id=\"webhook-structure\">Webhook structure<\/h2>\n<p>In general, the body of a webhook contains the following objects.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Data type<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>data<\/code><\/td>\n<td style=\"text-align: left;\">Object<\/td>\n<td style=\"text-align: left;\">Object that contains information about the event.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>environment<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: left;\">The environment where the transaction was processed&mdash;<span translate=\"no\"><strong>test<\/strong><\/span> or <span translate=\"no\"><strong>live<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>type<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: left;\">The <a href=\"#type\">webhook type<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>The information contained in the <code>data<\/code> object varies and depends on the webhook type. You can find the full schema for each type in  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">API Explorer<\/a>.<\/p>\n<p>Below is an example request body for a webhook of <code>type<\/code> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.created\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.created<\/a>.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example webhook request body'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n  \\\"data\\\": {\\n    \\\"balancePlatform\\\": \\\"YOUR_BALANCE_PLATFORM\\\",\\n    \\\"accountHolder\\\": {\\n      \\\"contactDetails\\\": {\\n        \\\"address\\\": {\\n          \\\"country\\\": \\\"NL\\\",\\n          \\\"houseNumberOrName\\\": \\\"274\\\",\\n          \\\"postalCode\\\": \\\"1020CD\\\",\\n          \\\"street\\\": \\\"Brannan Street\\\"\\n        },\\n        \\\"email\\\": \\\"s.hopper@example.com\\\",\\n        \\\"phone\\\": {\\n          \\\"number\\\": \\\"+315551231234\\\",\\n          \\\"type\\\": \\\"Mobile\\\"\\n        }\\n      },\\n      \\\"description\\\": \\\"S.Hopper - Staff 123\\\",\\n      \\\"id\\\": \\\"AH00000000000000000000001\\\",\\n      \\\"status\\\": \\\"Active\\\"\\n    }\\n  },\\n  \\\"environment\\\": \\\"test\\\",\\n  \\\"type\\\": \\\"balancePlatform.accountHolder.created\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"type\">Webhook types<\/h2>\n<p>Webhooks are typically sent when:<\/p>\n<ul>\n<li>A resource was created or updated.<\/li>\n<li>A request was initiated (such as a payment authorisation request, a refund request, or a funds transfer request).<\/li>\n<li>There was a funds movement (funds added to or deducted from balance accounts).<\/li>\n<\/ul>\n<p>You can differentiate the events based on the <code>type<\/code>. Some webhook types also include a <code>data.status<\/code> field that informs you of the outcome of the event.<\/p>\n<h3>Configuration webhooks<\/h3>\n<p>Configuration webhooks inform your system about events that occur with account holders, balance accounts, and payment instruments.<\/p>\n<div class=\"sticky-table-container\">\n    \n<table>\n<thead>\n<tr>\n<th>Type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.created\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.created<\/a><\/td>\n<td>An <a href=\"\/pt\/payouts\/payout-service\/account-structure-resources#balance-platform-resources\">account holder<\/a>  was successfully created.<\/td>\n<\/tr>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.updated\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.updated<\/a><\/td>\n<td>An account holder was successfully updated.<\/td>\n<\/tr>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.balanceAccount.created\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.balanceAccount.created<\/a><\/td>\n<td>A <a href=\"\/pt\/payouts\/payout-service\/account-structure-resources#balance-platform-resources\">balance account<\/a> was successfully created.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform-webhooks\/latest\/post\/balancePlatform.balanceAccount.updated\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.balanceAccount.updated<\/a><\/td>\n<td>A balance account was successfully updated.<\/td>\n<\/tr>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.balanceAccountSweep.created\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.balanceAccountSweep.created<\/a><\/td>\n<td>A <a href=\"\/pt\/payouts\/payout-service\/internal-fund-transfers\/scheduled-fund-transfers\">balance account sweep<\/a> was successfully created.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform-webhooks\/latest\/post\/balancePlatform.balanceAccountSweep.deleted\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.balanceAccountSweep.deleted<\/a><\/td>\n<td>A balance account sweep was successfully deleted.<\/td>\n<\/tr>\n<tr>\n<td><a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.balanceAccountSweep.updated\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.balanceAccountSweep.updated<\/a><\/td>\n<td>A balance account sweep was successfully updated.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n<h3 id=\"transfer-webhooks\">Transfer webhooks<\/h3>\n<p>Transfer webhooks inform your system about incoming and outgoing transfers in your platform.<\/p>\n<table>\n<thead>\n<tr>\n<th>Type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <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><\/td>\n<td>A transfer request was created to credit funds to or deduct funds from a balance account in your platform. The content informs you of the <a href=\"#transfer-event\">event that triggered the transfer request<\/a>, such as a payment or refund.<\/td>\n<\/tr>\n<tr>\n<td> <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><\/td>\n<td>A transfer request's status changed.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><a id=transfer-event><\/a><br \/>\nYou can identify transfer webhooks sent for different events by checking the following parameters and values:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\"><\/th>\n<th style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.created#request-data-category\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">category<\/a><\/th>\n<th style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.created#request-data-type\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">type<\/a><\/th>\n<th style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.updated#request-data-counterparty\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">counterparty<\/a><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><a href=\"\/pt\/payouts\/payout-service\/internal-fund-transfers\/internal-transfer-webhooks\">Internal transfer<\/a><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>internal<\/strong><\/span><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>internalTransfer<\/strong><\/span><\/td>\n<td style=\"text-align: left;\"><code>balanceAccountId<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><a href=\"\/pt\/payouts\/payout-service\/pay-out-to-bank-accounts\/payout-webhooks\">Third-party payout<\/a><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>bank<\/strong><\/span><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>bankTransfer<\/strong><\/span><\/td>\n<td style=\"text-align: left;\"><code>bankAccount<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/webhook-types","articleFields":{"section_label":"Webhooks","description":"Learn which webhook types are sent for each event.","last_edit_on":"16-03-2020 15:03","cache_enable":false,"parameters":{"integrationType":"payouts","directoryPath":"\/payouts\/payout-service"},"feedback_component":true},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/webhook-types","title":"Webhook structure and types for payouts","content":"On this page, you'll find information about:\n\nThe general webhook structure.\nThe types of webhooks.\n\nYou'll also learn about which webhook types are sent based on which event.\nWebhook structure\nIn general, the body of a webhook contains the following objects.\n\n\n\nParameter\nData type\nDescription\n\n\n\n\ndata\nObject\nObject that contains information about the event.\n\n\nenvironment\nString\nThe environment where the transaction was processed&mdash;test or live.\n\n\ntype\nString\nThe webhook type.\n\n\n\nThe information contained in the data object varies and depends on the webhook type. You can find the full schema for each type in  API Explorer.\nBelow is an example request body for a webhook of type balancePlatform.accountHolder.created.\n\n    \n\nWebhook types\nWebhooks are typically sent when:\n\nA resource was created or updated.\nA request was initiated (such as a payment authorisation request, a refund request, or a funds transfer request).\nThere was a funds movement (funds added to or deducted from balance accounts).\n\nYou can differentiate the events based on the type. Some webhook types also include a data.status field that informs you of the outcome of the event.\nConfiguration webhooks\nConfiguration webhooks inform your system about events that occur with account holders, balance accounts, and payment instruments.\n\n    \n\n\n\nType\nDescription\n\n\n\n\nbalancePlatform.accountHolder.created\nAn account holder  was successfully created.\n\n\nbalancePlatform.accountHolder.updated\nAn account holder was successfully updated.\n\n\nbalancePlatform.balanceAccount.created\nA balance account was successfully created.\n\n\n balancePlatform.balanceAccount.updated\nA balance account was successfully updated.\n\n\nbalancePlatform.balanceAccountSweep.created\nA balance account sweep was successfully created.\n\n\n balancePlatform.balanceAccountSweep.deleted\nA balance account sweep was successfully deleted.\n\n\nbalancePlatform.balanceAccountSweep.updated\nA balance account sweep was successfully updated.\n\n\n\n\n\n\nTransfer webhooks\nTransfer webhooks inform your system about incoming and outgoing transfers in your platform.\n\n\n\nType\nDescription\n\n\n\n\n balancePlatform.transfer.created\nA transfer request was created to credit funds to or deduct funds from a balance account in your platform. The content informs you of the event that triggered the transfer request, such as a payment or refund.\n\n\n balancePlatform.transfer.updated\nA transfer request's status changed.\n\n\n\n\nYou can identify transfer webhooks sent for different events by checking the following parameters and values:\n\n\n\n\n category\n type\n counterparty\n\n\n\n\nInternal transfer\ninternal\ninternalTransfer\nbalanceAccountId\n\n\nThird-party payout\nbank\nbankTransfer\nbankAccount\n\n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Webhook structure and types for payouts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payouts","lvl2":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service","lvl3":"\/pt\/payouts\/payout-service\/webhook-types"},"levels":4,"category":"","category_color":"","tags":["Webhook","structure","types","payouts"]}}
