Ledger balances

Create balance monitor

Create a balance monitor with the TypeScript SDK.

POST/balance-monitors

Use blnk.BalanceMonitor.create to set up balance monitoring on an existing balance.

Call the method

const response = await blnk.BalanceMonitor.create({
  balance_id: 'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
  condition: {
    field: 'credit_balance',
    operator: '>',
    value: 1000,
    precision: 100,
  },
  call_back_url: 'https://api.example.com/balance-monitor',
  description: 'Low balance alert',
});

Field	Type	Description
`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.

Save the monitor ID

Use response.data.monitor_id to retrieve or update the monitor later.

Response

{
  "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "condition": {
    "field": "credit_balance",
    "operator": ">",
    "value": 1000,
    "precision": 100
  },
  "call_back_url": "https://api.example.com/balance-monitor",
  "description": "Low balance alert",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}

Field	Type	Description
`monitor_id`	`string`	Unique ID for the monitor.
`balance_id`	`string`	Balance being monitored.
`condition`	`object`	Threshold rule you passed in the request.
`call_back_url`	`string`	Webhook URL for notifications.
`description`	`string`	Description for the monitor.
`created_at`	`string`	Date and time when the monitor was created.