Ledger balances
Create balance monitor
Create a balance monitor with the Python SDK.
POST
Create balance monitor
Use
blnk.balance_monitor.create to set up balance monitoring on an existing balance.
Call the method
blnk.balance_monitor.create
| Field | Type | Description |
|---|---|---|
balance_id | str | Balance to monitor. |
condition | dict | Threshold rule with field, operator, value, and precision. |
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 when the condition is met. |
description | str | Optional description for the monitor. |
Response
201 Created
| Field | Type | Description |
|---|---|---|
monitor_id | str | Unique ID for the monitor. |
balance_id | str | Balance being monitored. |
condition | dict | Threshold rule you passed in the request. |
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. |
Related docs
Balance monitoring
Conditions and webhook behavior.
Create balance monitor
HTTP request and response schema.