Balances

Create a balance webhook setting

Changed on

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).

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

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings
  • Auth
    none declared

Path parameters

balancePlatformIdstring required

The unique identifier of the balance platform.

webhookIdstring required

The unique identifier of the balance webhook.

Request body

currencystring required

The three-character ISO currency code of the balance.

status'active' | 'inactive' required

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.
type'balance' required

The type of the webhook you are configuring. Set to balance.

Response

OK - the request has succeeded.

currencystring required

The three-character ISO currency code of the balance.

idstring required

The unique identifier of the webhook setting.

statusstring required
type'balance' required

Changes

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the / request property's minLength was increased from 0 to 1

    • info

      mapped value for key balance changed from to from the response discriminator for the response status