---
title: "Update a balance webhook setting by id"
method: PATCH
path: "/balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}"
tags: ["Balances"]
---

# Update a balance webhook setting by id

`PATCH /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}`

Updates the conditions the balance change needs to meet for Adyen to send a [balance webhook](https://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated).

## Path parameters

- `balancePlatformId` string, required
- `webhookId` string, required
- `settingId` string, required

## Request body

- BalanceWebhookSettingInfoUpdate
  - `conditions` Condition[], nullable — The array of conditions a balance change must meet for Adyen to send the webhook.
    - `balanceType` 'balance' | 'available' | 'pending' | 'reserved', required — 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.
    - `conditionType` 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual', required — 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`.
    - `value` integer, required — The value limit in the specified balance type and currency, in minor units.
  - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) 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.
  - `target` TargetUpdate
    - `id` string — The unique identifier of the `target.type`. This can be the ID of your: * balance platform * account holder * account holder's balance account
    - `type` 'balanceAccount' | 'accountHolder' | 'balancePlatform' — 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.
  - `type` 'balance' — The type of the webhook you are configuring. Set to **balance**.

## Response `200`

OK - the request has succeeded.

- WebhookSetting
  - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.
  - `id` string, required — The unique identifier of the webhook setting.
  - `status` string, required
  - `target` Target, required
    - `id` string, required — The unique identifier of the `target.type`. This can be the ID of your: * balance platform * account holder * account holder's balance account
    - `type` 'balanceAccount' | 'accountHolder' | 'balancePlatform', required — 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.
  - `type` 'balance', required

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `404` — Not Found - the payment was not found
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

## Changes

- **2025-10-06** (v2) `7c2bc8ccb9bf` — 2 breaking
  - the `currency` request property's minLength was increased from `0` to `1`
  - the `target/id` request property's minLength was increased from `0` to `1`
- **2025-04-29** (v2) `508e86c65b0b` — 1 info
  - mapped value for key `balance` changed from `#/components/schemas/BalanceWebhookSettingsResponse` to `#/components/schemas/BalanceWebhookSetting` from the response discriminator for the response status `200`
- **2025-03-20** (v2) `e69e67d2e692` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/adyen/apis/balanceplatformservice/changes/balancePlatforms/:balancePlatformId/webhooks/:webhookId/settings/:settingId/patch.md)

---

[API](https://skmtc.dev/adyen/apis/balanceplatformservice.md) · [All operations](https://skmtc.dev/adyen/apis/balanceplatformservice/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/balanceplatformservice/revisions/8761ac1a9aab/schema)