ADadyen
Balances

Update a balance webhook setting by id

Changed on

Updates the conditions the balance change needs to meet for Adyen to send a balance webhook.

patch/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}

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/{settingId}
  • Auth
    none declared

Path parameters

balancePlatformIdstring required

The unique identifier of the balance platform.

webhookIdstring required

The unique identifier of the balance webhook.

settingIdstring required

The unique identifier of the balance webhook setting.

Request body

currencystring

The three-character ISO currency code of the balance.

status'active' | 'inactive'

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'

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

  • v27c2bc8ccb9bfRevision 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

  • v2508e86c65b0bRevision changes
    • info

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