Update a Balance
Use this endpoint to update the information of an existing balance.
Headers
The type of media of the resource. Recommended value is application/json.
A unique identifier used to trace and track each request.
Bearer JWT token for authentication.
Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments).
Optional in default OSS single-tenant mode.
Format: Bearer <token>
Path Parameters
The unique identifier of the Organization associated with the Ledger.
The unique identifier of the associated Ledger.
The unique identifier of the balance that you want to retrieve.
Body
If true, indicates that the balance can be used to send transactions.
If true, indicates that the balance can be used to receive transactions.
When provided, replaces the existing settings in full. Use this to toggle allowOverdraft or adjust overdraftLimit. Direction cannot be changed via update — it is immutable after creation.
Response
Indicates that the request was successful and the response contains the expected data.
The unique identifier of the Balance.
The unique identifier of the Organization.
The unique identifier of the Ledger.
The unique identifier of the Account.
The alias for the account used in the operation.
The unique identifier for the balance in the context of the account.
The name of the asset used in the operation.
Previous available balance.
Amount on hold/reserved.
Balance version, which is updated with each transaction.
The type of account.
If true, indicates that the balance can be used to send transactions.
If true, indicates that the balance can be used to receive transactions.
The accounting direction of the balance. credit balances grow on credit and shrink on debit; debit balances grow on debit and shrink on credit. Set at creation and immutable.
credit, debit The amount of overdraft currently consumed by this balance, as a decimal string. Always non-negative; "0" when the balance has no overdraft active.
Optional per-balance configuration (overdraft, scope). null for legacy balances without custom settings.
Computed view of the balance state at response time. Always present; never persisted. Re-derived from available, onHold, overdraftUsed, and settings on every read.
Timestamp of creation (UTC).
Timestamp of last update (UTC).
Timestamp of soft deletion, if applicable (UTC).
An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.
Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.