Skip to main content
POST
/
balance-monitors
Create balance monitor
curl --request POST \
  --url http://localhost:5001/balance-monitors \
  --header 'X-blnk-key: <api-key>'
Use blnk.BalanceMonitor.create to set up balance monitoring on an existing balance.
blnk.BalanceMonitor.create
const response = await blnk.BalanceMonitor.create({
  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',
});
FieldDescription
balance_idBalance to monitor.
conditionThreshold rule with field, operator, value, and precision.
condition.fieldBalance field to watch (for example credit_balance, debit_balance, balance).
condition.operatorComparison operator: >, <, or =.
condition.valueThreshold amount.
condition.precisionCurrency precision (for example 100 for cents).
call_back_urlWebhook URL when the condition is met.
descriptionOptional description for the monitor.

​
Response shape

201 Created
{
  "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"
}
FieldDescription
monitor_idUnique ID for the monitor.
balance_idBalance being monitored.
conditionThreshold rule you passed in the request.
call_back_urlWebhook URL for notifications.
descriptionDescription for the monitor.
created_atDate and time when the monitor was created.

Balance monitoring

Conditions and webhook behavior.

Create balance monitor

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.