Ledger balances

View balance monitor details

Get one balance monitor with the Python SDK.

GET/balance-monitors/{monitor_id}

Use blnk.balance_monitor.get to retrieve a balance monitor by ID.

Call the method

response = blnk.balance_monitor.get(
  "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
)

Field	Type	Description
`id`	`str`	Monitor ID to retrieve.

Use the monitor details

Read response.data for the threshold condition, webhook URL, and linked balance_id.

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`	`str`	Unique ID for the monitor.
`balance_id`	`str`	Balance being monitored.
`condition`	`dict`	Threshold rule for the monitor.
`condition.field`	`str`	Balance field to watch (for example `credit_balance`, `debit_balance`, `balance`).
`condition.operator`	`str`	Comparison operator: `>`, `<`, `=`, `!=`, `>=`, `<=`.
`condition.value`	`number`	Threshold amount.
`condition.precision`	`number`	Currency precision (for example `100` for cents).
`call_back_url`	`str`	Webhook URL for notifications.
`description`	`str`	Description for the monitor.
`created_at`	`str`	Date and time when the monitor was created.