{"title":"Manage your balance webhook settings","category":"default","creationDate":1776961627,"content":"<p><span style=\"color: #0ABF53;\"><span style=\"font-size: 20px;\"><strong>Limited availability<\/strong><\/span><\/span><br \/>\nBalance webhooks are in pilot phase. Some of the processes and documentation may change as the feature evolves.<\/p>\n<hr \/>\n<p>You can view, update, and delete your balance webhook settings by using the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration API<\/a>.<\/p>\n<h2>View all balance webhook settings<\/h2>\n<p>To get the list of settings and conditions for triggering the webhook, make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balancePlatforms\/{id}\/webhooks\/{id}\/settings<\/a> request, specifying the ID of your balance platform and the ID of your balance webhook as path parameters.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Get all settings'\" :id=\"'get-settings'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/balancePlatforms\\\/YourBalancePlatform\\\/webhooks\\\/WBHK00000000000000000000000001\\\/settings \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\\\n-d&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"[\\n    {\\n        \\\"id\\\": \\\"BWHS00000000000000000000000001\\\",\\n        \\\"type\\\": \\\"balance\\\",\\n        \\\"target\\\": {\\n            \\\"type\\\": \\\"balancePlatform\\\",\\n            \\\"id\\\": \\\"YOUR_BALANCE_PLATFORM\\\"\\n        },\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"status\\\": \\\"active\\\",\\n        \\\"conditions\\\": [\\n            {\\n                \\\"balanceType\\\": \\\"available\\\",\\n                \\\"conditionType\\\": \\\"lessThan\\\",\\n                \\\"value\\\": 500000\\n            }\\n        ]\\n    },\\n    {\\n        \\\"id\\\": \\\"BWHS00000000000000000000000002\\\",\\n        \\\"type\\\": \\\"balance\\\",\\n        \\\"target\\\": {\\n            \\\"type\\\": \\\"balanceAccount\\\",\\n            \\\"id\\\": \\\"BA00000000000000000LIABLE\\\"\\n        },\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"status\\\": \\\"active\\\",\\n        \\\"conditions\\\": [\\n            {\\n                \\\"balanceType\\\": \\\"available\\\",\\n                \\\"conditionType\\\": \\\"greaterThan\\\",\\n                \\\"value\\\": 1000000\\n            }\\n        ]\\n    }\\n]\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>View the conditions in a balance webhook setting<\/h2>\n<p>To get details of a balance webhook setting with the conditions for triggering the webhook, make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balancePlatforms\/{id}\/webhooks\/{id}\/settings\/{id}<\/a> request, specifying the following IDs as path parameters:<\/p>\n<ul>\n<li>balance platform ID<\/li>\n<li>balance webhook ID<\/li>\n<li>balance webhook setting ID<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Get setting details'\" :id=\"'get-a-setting'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/balancePlatforms\\\/YourBalancePlatform\\\/webhooks\\\/WBHK00000000000000000000000001\\\/settings\\\/BWHS00000000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\\\n-d&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"id\\\": \\\"BWHS00000000000000000000000001\\\",\\n    \\\"type\\\": \\\"balance\\\",\\n    \\\"target\\\": {\\n        \\\"type\\\": \\\"balancePlatform\\\",\\n        \\\"id\\\": \\\"YOUR_BALANCE_PLATFORM\\\"\\n    },\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"status\\\": \\\"active\\\",\\n    \\\"conditions\\\": [\\n        {\\n            \\\"balanceType\\\": \\\"available\\\",\\n            \\\"conditionType\\\": \\\"lessThan\\\",\\n            \\\"value\\\": 500000\\n        }\\n    ]\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>Update a balance webhook setting<\/h2>\n<p>To update the conditions for triggering balance webhooks, make a PATCH  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balancePlatforms\/{id}\/webhooks\/{id}\/settings\/{id}<\/a> request, specifying the following IDs as path parameters:<\/p>\n<ul>\n<li>balance platform ID<\/li>\n<li>balance webhook ID<\/li>\n<li>balance webhook setting ID<\/li>\n<\/ul>\n<p>In the body of the request, include the following parameters:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter<\/th>\n<th style=\"text-align: left;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-type\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">type<\/a><\/td>\n<td style=\"text-align: left;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">The type of the webhook you want to configure. Set this to <strong>balance<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-target-type\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">target.type<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">The resource for which you want to receive webhooks. Possible values:<ul><li><strong>balancePlatform<\/strong>: receive webhooks for balance changes in your entire balance platform.<\/li><li><strong>accountHolder<\/strong>: receive webhooks for balance changes of a specific user.<\/li><li><strong>balanceAccount<\/strong>: receive webhooks for balance changes in a specific balance account.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-target-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">target.id<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">The unique identifier of the <code>target.type<\/code>. This can be the ID of your balance platform, your account holder, or your account holder's balance account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-currency\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">currency<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">The currency of the balance for which you want to receive webhooks.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-status\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">status<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">Specifies the status of the webhook setting.<br>Possible values:<ul><li><strong>active<\/strong>: You receive a balance webhook if any of the conditions in this setting are met.<\/li><li><strong>inactive<\/strong>: You do not receive a balance webhook even if the conditions in this settings are met.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-conditions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">conditions<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">The array of conditions a balance change must meet for Adyen to send the webhook.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-conditions-balanceType\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">conditions.balanceType<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">The type of balance for which you want to receive webhooks. Possible values:<ul><li><strong>available<\/strong>: the balance available for use.<\/li><li><strong>balance<\/strong>: the sum of transactions that have already been settled.<\/li><li><strong>pending<\/strong>: the sum of transactions that will be settled in the future.<\/li><li><strong>reserved<\/strong>: the balance currently held in reserve.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-conditions-conditionType\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">conditions.conditionType<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">Possible values: <strong>greaterThan<\/strong>, <strong>greaterThanOrEqual<\/strong>, <strong>lessThan<\/strong>, <strong>lessThanOrEqual<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/patch\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)#request-conditions-value\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">conditions.value<\/a><\/td>\n<td style=\"text-align: left;\"><\/td>\n<td style=\"text-align: left;\">The value limit you set in the specified <code>balanceType<\/code> and <code>currency<\/code>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>Examples<\/h3>\n<p>The following examples provide an overview of the most common reasons to update a balance webhook setting.<\/p>\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#add-a-new-set-of-conditions\">\n                                    <h4 class=\"adl-accordion__title\">Add a new set of conditions<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<p>To add a new set of conditions to a balance webhook setting, send both the existing and the new condition set in the <code>conditions<\/code> array.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Add new condition set'\" :id=\"'add-conditions'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/balancePlatforms\\\/YourBalancePlatform\\\/webhooks\\\/WBHK00000000000000000000000001\\\/settings\\\/BWHS00000000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X PATCH \\\\\\n-d '{\\n    \\&quot;type\\&quot;: \\&quot;balance\\&quot;,\\n    \\&quot;target\\&quot; : {\\n        \\&quot;type\\&quot;: \\&quot;balanceAccount\\&quot;,\\n        \\&quot;id\\&quot;: \\&quot;BA00000000000000000LIABLE\\&quot;\\n    },\\n    \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n    \\&quot;status\\&quot;: \\&quot;active\\&quot;,\\n    \\&quot;conditions\\&quot;: [\\n        {\\n            \\&quot;balanceType\\&quot;: \\&quot;available\\&quot;,\\n            \\&quot;conditionType\\&quot;: \\&quot;lessThan\\&quot;,\\n            \\&quot;value\\&quot;: 500000\\n        },\\n        {\\n            \\&quot;balanceType\\&quot;: \\&quot;balance\\&quot;,\\n            \\&quot;conditionType\\&quot;: \\&quot;greaterThan\\&quot;,\\n            \\&quot;value\\&quot;: 1000000\\n        }\\n    ]\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#remove-a-set-of-conditions\">\n                                    <h4 class=\"adl-accordion__title\">Remove a set of conditions<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<p>To remove a set of conditions from a balance webhook setting, exclude them from <code>conditions<\/code> array when you send the update request.<\/p>\n<div class=\"notices green\">\n<p>You must send the conditions you want to keep in the update request.<\/p>\n<\/div>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Remove condition set'\" :id=\"'remove-conditions'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/balancePlatforms\\\/YourBalancePlatform\\\/webhooks\\\/WBHK00000000000000000000000001\\\/settings\\\/BWHS00000000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X PATCH \\\\\\n-d '{\\n    \\&quot;type\\&quot;: \\&quot;balance\\&quot;,\\n    \\&quot;target\\&quot; : {\\n        \\&quot;type\\&quot;: \\&quot;balanceAccount\\&quot;,\\n        \\&quot;id\\&quot;: \\&quot;BA00000000000000000LIABLE\\&quot;\\n    },\\n    \\&quot;currency\\&quot;: \\&quot;USD\\&quot;,\\n    \\&quot;status\\&quot;: \\&quot;active\\&quot;,\\n    \\&quot;conditions\\&quot;: [\\n        {\\n            \\&quot;balanceType\\&quot;: \\&quot;available\\&quot;,\\n            \\&quot;conditionType\\&quot;: \\&quot;lessThan\\&quot;,\\n            \\&quot;value\\&quot;: 500000\\n        }\\n    ]\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#deactivate-a-setting\">\n                                    <h4 class=\"adl-accordion__title\">Deactivate a setting<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<p>To temporarily stop receiving webhooks for the specified conditions, set the <code>status<\/code> of the webhook setting to <strong>inactive<\/strong>.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Deactivate a setting'\" :id=\"'deactivate-setting'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/balancePlatforms\\\/YourBalancePlatform\\\/webhooks\\\/WBHK00000000000000000000000001\\\/settings\\\/BWHS00000000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X PATCH \\\\\\n-d '{\\n    \\&quot;type\\&quot;: \\&quot;balance\\&quot;,\\n    \\&quot;status\\&quot;: \\&quot;inactive\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#remove-all-conditions\">\n                                    <h4 class=\"adl-accordion__title\">Remove all conditions<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<p>If you remove the only existing condition set from the webhook setting, you will receive updates for <em>all<\/em> balance changes in the specified balance account(s).<\/p>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<h2>Delete a balance webhook setting<\/h2>\n<p>If you want to permanently stop receiving webhooks for the specified conditions, send a DELETE  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/delete\/balancePlatforms\/(balancePlatformId)\/webhooks\/(webhookId)\/settings\/(settingId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/balancePlatforms\/{id}\/webhooks\/{id}\/settings\/{id}<\/a> request, specifying the following IDs as path parameters:<\/p>\n<ul>\n<li>balance platform ID<\/li>\n<li>balance webhook ID<\/li>\n<li>balance webhook setting ID<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Delete setting'\" :id=\"'delete-setting'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/balancePlatforms\\\/YourBalancePlatform\\\/webhooks\\\/WBHK00000000000000000000000001\\\/settings\\\/BWHS00000000000000000000000001 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X DELETE \\\\\\n-d&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>See also<\/h2>\n<div class=\"next-steps\" id=\"next-steps\" >\n<a href=\"\/marketplaces\/balance-updates\/configure-balance-webhook\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><div class=\"next-steps__title\">Configure balance webhook settings<\/div><p class=\"next-steps__body\"><p>Learn how you can configure and receive automatic notifications about the changes to balances in your balance platform.<\/p><\/p><\/a><a href=\"\/marketplaces\/balance-updates\/use-cases\" class=\"next-steps__step\" style=\"width:45%;\" target=\"_self\"><div class=\"next-steps__title\">Use cases<\/div><p class=\"next-steps__body\"><p>See examples of how you can configure the balance webhook for specific use cases.<\/p><\/p><\/a><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/balance-updates\/manage-balance-webhook","articleFields":{"description":"Learn how you can update or delete your balance webhook settings.","cache_enable":false,"parameters":{"directoryPath":"\/marketplaces","model":"marketplace"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/balance-updates\/manage-balance-webhook","title":"Manage your balance webhook settings","content":"Limited availability\nBalance webhooks are in pilot phase. Some of the processes and documentation may change as the feature evolves.\n\nYou can view, update, and delete your balance webhook settings by using the  Configuration API.\nView all balance webhook settings\nTo get the list of settings and conditions for triggering the webhook, make a GET  \/balancePlatforms\/{id}\/webhooks\/{id}\/settings request, specifying the ID of your balance platform and the ID of your balance webhook as path parameters.\n\n    \n\n\n    \n\nView the conditions in a balance webhook setting\nTo get details of a balance webhook setting with the conditions for triggering the webhook, make a GET  \/balancePlatforms\/{id}\/webhooks\/{id}\/settings\/{id} request, specifying the following IDs as path parameters:\n\nbalance platform ID\nbalance webhook ID\nbalance webhook setting ID\n\n\n    \n\n\n    \n\nUpdate a balance webhook setting\nTo update the conditions for triggering balance webhooks, make a PATCH  \/balancePlatforms\/{id}\/webhooks\/{id}\/settings\/{id} request, specifying the following IDs as path parameters:\n\nbalance platform ID\nbalance webhook ID\nbalance webhook setting ID\n\nIn the body of the request, include the following parameters:\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\n type\n\nThe type of the webhook you want to configure. Set this to balance.\n\n\n target.type\n\nThe resource for which you want to receive webhooks. Possible values:balancePlatform: receive webhooks for balance changes in your entire balance platform.accountHolder: receive webhooks for balance changes of a specific user.balanceAccount: receive webhooks for balance changes in a specific balance account.\n\n\n target.id\n\nThe unique identifier of the target.type. This can be the ID of your balance platform, your account holder, or your account holder's balance account.\n\n\n currency\n\nThe currency of the balance for which you want to receive webhooks.\n\n\n status\n\nSpecifies the status of the webhook setting.Possible values:active: You receive a balance webhook if any of the conditions in this setting are met.inactive: You do not receive a balance webhook even if the conditions in this settings are met.\n\n\n conditions\n\nThe array of conditions a balance change must meet for Adyen to send the webhook.\n\n\n conditions.balanceType\n\nThe type of balance for which you want to receive webhooks. Possible values:available: the balance available for use.balance: the sum of transactions that have already been settled.pending: the sum of transactions that will be settled in the future.reserved: the balance currently held in reserve.\n\n\n conditions.conditionType\n\nPossible values: greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual.\n\n\n conditions.value\n\nThe value limit you set in the specified balanceType and currency.\n\n\n\nExamples\nThe following examples provide an overview of the most common reasons to update a balance webhook setting.\n\n    \n    \n        \n            \n            \n                                    Add a new set of conditions\n                            \n        \n        \n            \nTo add a new set of conditions to a balance webhook setting, send both the existing and the new condition set in the conditions array.\n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Remove a set of conditions\n                            \n        \n        \n            \nTo remove a set of conditions from a balance webhook setting, exclude them from conditions array when you send the update request.\n\nYou must send the conditions you want to keep in the update request.\n\n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Deactivate a setting\n                            \n        \n        \n            \nTo temporarily stop receiving webhooks for the specified conditions, set the status of the webhook setting to inactive.\n\n    \n\n\n        \n    \n\n\n\n    \n    \n        \n            \n            \n                                    Remove all conditions\n                            \n        \n        \n            \nIf you remove the only existing condition set from the webhook setting, you will receive updates for all balance changes in the specified balance account(s).\n\n        \n    \n\n\nDelete a balance webhook setting\nIf you want to permanently stop receiving webhooks for the specified conditions, send a DELETE  \/balancePlatforms\/{id}\/webhooks\/{id}\/settings\/{id} request, specifying the following IDs as path parameters:\n\nbalance platform ID\nbalance webhook ID\nbalance webhook setting ID\n\n\n    \n\nSee also\n\nConfigure balance webhook settingsLearn how you can configure and receive automatic notifications about the changes to balances in your balance platform.Use casesSee examples of how you can configure the balance webhook for specific use cases.\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Marketplaces","lvl2":"Track balance updates","lvl3":"Manage your balance webhook settings"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/marketplaces","lvl2":"https:\/\/docs.adyen.com\/pt\/marketplaces\/balance-updates","lvl3":"\/pt\/marketplaces\/balance-updates\/manage-balance-webhook"},"levels":4,"category":"Marketplaces","category_color":"green","tags":["Manage","balance","webhook","settings"]}}