Sign in
Balances

Update a balance webhook setting by id

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

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

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

Changed in 3 of the 51 revisions of this API.22

  • v27c2bc8ccb9bf2See the full diff
    • ▲

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

      request-property-min-length-increased

    • ▲

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

      request-property-min-length-increased

  • v2508e86c65b0b1See the full diff
    • ○

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

      response-body-discriminator-mapping-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v2e69e67d2e6921See the full diff
    • ○

      endpoint added

      endpoint-added