--- title: "Update a balance account" method: PATCH path: "/balanceAccounts/{id}" tags: ["Balance accounts"] --- # Update a balance account `PATCH /balanceAccounts/{id}` Updates a balance account. ## Path parameters - `id` string, required ## Request body - BalanceAccountUpdateRequest - `accountHolderId` string — The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account. - `description` string — A human-readable description of the balance account. You can use this parameter to distinguish between multiple balance accounts under an account holder. - `metadata` object — A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. - `platformPaymentConfiguration` PlatformPaymentConfiguration - `salesDayClosingTime` string, time — Specifies at what time a sales day ends for this account. Possible values: Time in **"HH:MM"** format. **HH** ranges from **00** to **07**. **MM** must be **00**. Default value: **"00:00"**. - `settlementDelayDays` integer — Specifies after how many business days the funds in a settlement batch are made available in this balance account. Requires Custom Sales Day Payout to be enabled for your balance account. Contact your account manager or implementation manager to enable this. Possible values: **1** to **20**, or **null**. Default value: **null**. - `reference` string — Your reference to the balance account. - `status` 'active' | 'closed' | 'inactive' | 'suspended' — The status of the balance account. Payment instruments linked to the balance account can only be used if the balance account status is **active**. Possible values: **active**, **closed**, **suspended**. - `timeZone` string — The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ## Response `200` OK - the request has succeeded. - BalanceAccount - `accountHolderId` string, required — The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account. - `balances` Balance[] — List of balances with the amount and currency. - `available` integer, required — The balance available for use. - `balance` integer, required — The sum of the transactions that have already been settled. - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance. - `pending` integer — The sum of the transactions that will be settled in the future. - `pendingAvailable` integer — The balance that will become the available balance after the pending balance is settled. The pending available balance is equal to the lower of the following: - The `pending` balance - The `pending` balance plus the `available` balance. - `reserved` integer, required — The balance currently held in reserve. - `defaultCurrencyCode` string — The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency. - `description` string — A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. - `id` string, required — The unique identifier of the balance account. - `metadata` object — A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. - `migratedAccountCode` string — The unique identifier of the account of the migrated account holder in the classic integration. - `platformPaymentConfiguration` PlatformPaymentConfiguration - `salesDayClosingTime` string, time — Specifies at what time a sales day ends for this account. Possible values: Time in **"HH:MM"** format. **HH** ranges from **00** to **07**. **MM** must be **00**. Default value: **"00:00"**. - `settlementDelayDays` integer — Specifies after how many business days the funds in a settlement batch are made available in this balance account. Requires Custom Sales Day Payout to be enabled for your balance account. Contact your account manager or implementation manager to enable this. Possible values: **1** to **20**, or **null**. Default value: **null**. - `reference` string — Your reference for the balance account, maximum 150 characters. - `status` 'active' | 'closed' | 'inactive' | 'suspended' — The status of the balance account, set to **active** by default. - `timeZone` string — The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ## Other responses - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `500` — Internal Server Error - the server could not process the request. --- [API](https://skmtc.net/adyen/apis/balanceplatformservice.md) · [All operations](https://skmtc.net/adyen/apis/balanceplatformservice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/balanceplatformservice/revisions/8761ac1a9aab/schema)