Ledger balances

Update balance monitor

Update the details of a balance monitor.

PUT/balance-monitors/{monitor_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Path

monitor_idstringrequiredpath

The unique id of the balance monitor to update.

Body

balance_idstringrequiredbody

Specifies the balance id of the ledger balance to be monitored.

conditionobjectrequiredbody

Defines the criteria for monitoring a specific balance type.

Details

fieldstringrequiredbody

Specifies the balance type to be monitored. Every ledger balance has 6 balance types - balance, inflight_balance, credit_balance, inflight_credit_balance, debit_balance, and inflight_debit_balance.

operatorstringrequiredbody

Comparison to apply: >, <, >=, <=, =, or !=.

valuenumberrequiredbody

Threshold in major units. 0 and fractions such as 100.50 are valid. The PUT writes this value as sent, including 0 when the field is omitted.

precisionnumberbody

Scale for value. Omit it to keep the stored precision. A sent precision is written, and precise_value is recomputed.

triggerstringbody

How you want the monitor to behave. edge notifies you once when the rule first matches, then stays quiet until the amount no longer matches.

level notifies you on every transaction that updates the balance while the rule still matches.

descriptionstringbody

A brief explanation of the purpose of the monitor. The PUT writes this as sent.

Response

messagestringrequired

Confirms the monitor was updated.

curl -X PUT "http://localhost:5001/balance-monitors/{monitor_id}" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
    "trigger": "level",
    "condition": {
      "field": "debit_balance",
      "operator": ">",
      "value": 1000,
      "precision": 100
    }
  }'

{
  "message": "BalanceMonitor updated successfully"
}

{
  "error": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found",
  "error_detail": {
    "code": "BAL_MONITOR_NOT_FOUND",
    "message": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found"
  }
}