Ledger balances

Update balance monitor

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

PUT/balance-monitors/{monitor_id}

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

Call the method

response = blnk.balance_monitor.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",
  },
)
FieldTypeDescription
idstrMonitor ID to update.
balance_idstrBalance to monitor.
conditiondictThreshold rule with field, operator, value, and precision.
condition.fieldstrBalance field to watch (for example credit_balance, debit_balance, balance).
condition.operatorstrComparison operator: >, <, =, !=, >=, <=.
condition.valuenumberThreshold amount.
condition.precisionnumberCurrency precision (for example 100 for cents).
call_back_urlstrWebhook URL when the condition is met.
descriptionstrOptional 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"
}
FieldTypeDescription
messagestrConfirmation from Core.