POST /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings

Configures the criteria for triggering balance webhooks.

Adyen sends balance webhooks to notify you of balance changes in your balance platform. They can be triggered when the balance reaches, exceeds, or drops below a specific value in a specific currency.

You can get notified about balance changes in your entire balance platform, in the balance accounts of a specific user, or a specific balance account. The hierarchy between the webhook settings are based on the following business logic:

Settings on a higher level apply to all lower level resources (balance platform > account holder > balance acocunt).
The most granular setting overrides higher level settings (balance account > account holder > balance platform).

Servers

https://balanceplatform-api-test.adyen.com/bcl/v2

Path parameters

Name	Type	Required	Description
`webhookId`	String	Yes	The unique identifier of the balance webhook.
`balancePlatformId`	String	Yes	The unique identifier of the balance platform.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`target`	Object	Yes	The type and ID of the resource about whose balance changes you want to be notified.
`target.id`	String	Yes	The unique identifier of the `target.type`. This can be the ID of your: balance platform account holder account holder's balance account
`target.type`	String	Yes	The resource for which you want to receive notifications. Possible values: balancePlatform: receive notifications about balance changes in your entire balance platform. accountHolder: receive notifications about balance changes of a specific user. balanceAccount: receive notifications about balance changes in a specific balance account. Possible values: `"balancePlatform"` `"accountHolder"` `"balanceAccount"`
`conditions[]`	Array	No	The array of conditions a balance change must meet for Adyen to send the webhook.
`conditions[].conditionType`	String	Yes	Define when you want to get notified about a balance change. Possible values: greaterThan: the balance in the account(s) exceeds the specified `value`. greaterThanOrEqual: the balance in the account(s) reaches or exceeds the specified `value`. lessThan: the balance in the account(s) drops below the specified `value`. lessThanOrEqual: the balance in the account(s) reaches to drops below the specified `value`. Possible values: `"lessThan"` `"greaterThanOrEqual"` `"lessThanOrEqual"` `"greaterThan"`
`conditions[].value`	Integer	Yes	The value limit in the specified balance type and currency, in minor units.
`conditions[].balanceType`	String	Yes	Define the type of balance about which you want to get notified. 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. Possible values: `"balance"` `"available"` `"pending"` `"reserved"`
`type`	String	Yes	The type of the webhook you are configuring. Set to balance. Possible values: `"balance"`
`status`	String	Yes	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. Possible values: `"inactive"` `"active"`
`currency`	String	Yes	The three-character ISO currency code of the balance.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.