Ledger balances

Create balance monitor

How to create a balance monitor in Blnk.

POST/balance-monitors

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.

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

Defines the comparison operator to apply. Accepted values: > (greater than), < (less than), or = (equal to).

valueintegerrequiredbody

The threshold amount that triggers the balance monitor.

descriptionstringbody

A brief explanation of the purpose of the monitor.

Response

monitor_idstring

The unique id of the balance monitor.

created_atstring

Date and time when the monitor was created.

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

{
  "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "condition": {
    "field": "debit_balance",
    "operator": ">",
    "value": 100000
  },
  "description": "",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}