{"title":"Example use cases","category":"default","creationDate":1776961627,"content":"

Limited availability<\/strong><\/span><\/span>
\nBalance webhooks are in pilot phase. Some of the processes and documentation may change as the feature evolves.<\/p>\n

\n

On this page, you can see examples of how you can configure the balance webhook for specific use cases, complete with example API requests and the triggered webhook event.<\/p>\n

Any current balance drops below a limit<\/h2>\n

Use case<\/h3>\n

I want to get notified if the balance drops below USD 5000 in any of the balance accounts in my balance platform.<\/p>\n

Create webhook setting and define conditions<\/h3>\n

Using the Configuration API<\/a>, create a webhook setting for the specific currency and value limit. In your API request, specify the following parameters and values:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalance<\/strong><\/td>\n<\/tr>\n
target.type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalancePlatform<\/strong><\/td>\n<\/tr>\n
target.id<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe id<\/code> of your balance platform, for example, YOUR_BALANCE_PLATFORM<\/strong>.<\/td>\n<\/tr>\n
currency<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nUSD<\/strong><\/td>\n<\/tr>\n
status<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nactive<\/strong><\/td>\n<\/tr>\n
conditions.balanceType<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalance<\/strong><\/td>\n<\/tr>\n
conditions.conditionType<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nlessThan<\/strong><\/td>\n<\/tr>\n
conditions.value<\/a><\/td>\n\"-white_check_mark-\"<\/td>\n500000<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n <\/code-sample>\n<\/div>\n

Webhook<\/h3>\n

The following example shows the webhook event you receive when the balance matches the condition.<\/p>\n

\n <\/code-sample>\n<\/div>\n

Current balance of a specific user drops below a limit<\/h2>\n

Use case<\/h3>\n

I want to be notified if the current balance reaches or drops below USD 5000 in any of my user's balance accounts.<\/p>\n

Create webhook setting and define conditions<\/h3>\n

Using the Configuration API<\/a>, create a webhook setting and specify the following parameters and values:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalance<\/strong><\/td>\n<\/tr>\n
target.type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\naccountHolder<\/strong><\/td>\n<\/tr>\n
target.id<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe accountHolderId<\/code> of your user, for example, AH00000000000000000000001<\/strong>.<\/td>\n<\/tr>\n
currency<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nUSD<\/strong><\/td>\n<\/tr>\n
status<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nactive<\/strong><\/td>\n<\/tr>\n
conditions.balanceType<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalance<\/strong><\/td>\n<\/tr>\n
conditions.conditionType<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nlessThanOrEqual<\/strong><\/td>\n<\/tr>\n
conditions.value<\/a><\/td>\n\"-white_check_mark-\"<\/td>\n500000<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n <\/code-sample>\n<\/div>\n

Webhook<\/h3>\n

The following example shows the webhook event you receive when the balance matches the condition.<\/p>\n

\n <\/code-sample>\n<\/div>\n

Available balance of a specific balance account drops below a limit<\/h2>\n

Use case<\/h3>\n

I want to get notified when the available balance on six of my users' balance accounts, which hold foreign currencies, drop below 1000 in their respective currencies.<\/p>\n

Create webhook setting and define conditions<\/h3>\n

Using the Configuration API<\/a>, create a webhook setting for each of the balance accounts<\/strong>, specifying the following parameters and values:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalance<\/strong><\/td>\n<\/tr>\n
target.type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nbalanceAccount<\/strong><\/td>\n<\/tr>\n
target.id<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe id<\/code> of the specific balance account, for example, BA00000000000000000000001<\/strong>.<\/td>\n<\/tr>\n
currency<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe currency of the balance for which you want to receive notifications. For example, JPY<\/strong>.<\/td>\n<\/tr>\n
status<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nactive<\/strong><\/td>\n<\/tr>\n
conditions.balanceType<\/a><\/td>\n\"-white_check_mark-\"<\/td>\navailable<\/strong><\/td>\n<\/tr>\n
conditions.conditionType<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nlessThan<\/strong><\/td>\n<\/tr>\n
conditions.value<\/a><\/td>\n\"-white_check_mark-\"<\/td>\n100000<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n <\/code-sample>\n<\/div>\n

Webhook<\/h3>\n

The following example shows the webhook event you receive when the balance matches the condition.<\/p>\n

\n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/balance-updates\/use-cases","articleFields":{"description":"See examples of how you can configure the balance webhook for specific use cases.","cache_enable":false,"parameters":{"directoryPath":"\/marketplaces","model":"marketplace"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/balance-updates\/use-cases","title":"Example use cases","content":"Limited availability\nBalance webhooks are in pilot phase. Some of the processes and documentation may change as the feature evolves.\n\nOn this page, you can see examples of how you can configure the balance webhook for specific use cases, complete with example API requests and the triggered webhook event.\nAny current balance drops below a limit\nUse case\nI want to get notified if the balance drops below USD 5000 in any of the balance accounts in my balance platform.\nCreate webhook setting and define conditions\nUsing the Configuration API, create a webhook setting for the specific currency and value limit. In your API request, specify the following parameters and values:\n\n\n\nParameter\nRequired\nValue\n\n\n\n\n type\n\nbalance\n\n\n target.type\n\nbalancePlatform\n\n\n target.id\n\nThe id of your balance platform, for example, YOUR_BALANCE_PLATFORM.\n\n\n currency\n\nUSD\n\n\n status\n\nactive\n\n\n conditions.balanceType\n\nbalance\n\n\n conditions.conditionType\n\nlessThan\n\n\n conditions.value\n\n500000\n\n\n\n\n \n\nWebhook\nThe following example shows the webhook event you receive when the balance matches the condition.\n\n \n\nCurrent balance of a specific user drops below a limit\nUse case\nI want to be notified if the current balance reaches or drops below USD 5000 in any of my user's balance accounts.\nCreate webhook setting and define conditions\nUsing the Configuration API, create a webhook setting and specify the following parameters and values:\n\n\n\nParameter\nRequired\nValue\n\n\n\n\n type\n\nbalance\n\n\n target.type\n\naccountHolder\n\n\n target.id\n\nThe accountHolderId of your user, for example, AH00000000000000000000001.\n\n\n currency\n\nUSD\n\n\n status\n\nactive\n\n\n conditions.balanceType\n\nbalance\n\n\n conditions.conditionType\n\nlessThanOrEqual\n\n\n conditions.value\n\n500000\n\n\n\n\n \n\nWebhook\nThe following example shows the webhook event you receive when the balance matches the condition.\n\n \n\nAvailable balance of a specific balance account drops below a limit\nUse case\nI want to get notified when the available balance on six of my users' balance accounts, which hold foreign currencies, drop below 1000 in their respective currencies.\nCreate webhook setting and define conditions\nUsing the Configuration API, create a webhook setting for each of the balance accounts, specifying the following parameters and values:\n\n\n\nParameter\nRequired\nValue\n\n\n\n\n type\n\nbalance\n\n\n target.type\n\nbalanceAccount\n\n\n target.id\n\nThe id of the specific balance account, for example, BA00000000000000000000001.\n\n\n currency\n\nThe currency of the balance for which you want to receive notifications. For example, JPY.\n\n\n status\n\nactive\n\n\n conditions.balanceType\n\navailable\n\n\n conditions.conditionType\n\nlessThan\n\n\n conditions.value\n\n100000\n\n\n\n\n \n\nWebhook\nThe following example shows the webhook event you receive when the balance matches the condition.\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Marketplaces","lvl2":"Track balance updates","lvl3":"Example use cases"},"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\/use-cases"},"levels":4,"category":"Marketplaces","category_color":"green","tags":["Example","cases"]}}