Ledger balances

Update balance monitor

Update the details of a balance monitor with the TypeScript SDK.

PUT/balance-monitors/{monitor_id}

Use blnk.BalanceMonitor.update to update a balance monitor.

Call the method

const response = await blnk.BalanceMonitor.update(
  'mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0',
  {
    balance_id: 'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
    condition: {
      field: 'credit_balance',
      operator: '<',
      value: 500,
      precision: 100,
    },
    call_back_url: 'https://api.example.com/balance-monitor',
  },
);

Field	Type	Description
`id`	`string`	Monitor ID to update.
`balance_id`	`string`	Balance to monitor.
`condition`	`object`	Threshold rule with `field`, `operator`, `value`, and `precision`.
`condition.field`	`string`	Balance field to watch (for example `credit_balance`, `debit_balance`, `balance`).
`condition.operator`	`string`	Comparison operator: `>`, `<`, `=`, `!=`, `>=`, `<=`.
`condition.value`	`number`	Threshold amount.
`condition.precision`	`number`	Currency precision (for example `100` for cents).
`call_back_url`	`string`	Webhook URL when the condition is met.
`description`	`string`	Optional description for the monitor.

Confirm the update

On success, Core returns a confirmation message. Fetch the monitor with get balance monitor to verify the new condition and webhook URL.

Response

{
  "message": "BalanceMonitor updated successfully"
}

Field	Type	Description
`message`	`string`	Confirmation from Core.