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 client.BalanceMonitor.Create to set up balance monitoring on an existing balance.
1

Call the method

client.BalanceMonitor.Create
monitor, resp, err := client.BalanceMonitor.Create(blnkgo.MonitorData{
	BalanceID: "bln_5ce86029-3c2e-4e2a",
	Condition: blnkgo.MonitorCondition{
		Field: "credit_balance",
		Operator: blnkgo.OperatorGreaterThan,
		Value: 1000,
		Precision: 100,
	},
	CallBackURL: "https://api.example.com/balance-monitor",
	Description: "Low balance alert",
})
FieldTypeDescription
BalanceIDstringBalance to monitor.
ConditionMonitorConditionThreshold rule with Field, Operator, Value, and Precision.
Condition.FieldstringBalance field to watch (for example credit_balance, debit_balance, balance).
Condition.OperatorMonitorConditionOperatorsComparison operator: >, <, =, !=, >=, <=.
Condition.Valueint64Threshold amount.
Condition.Precisionint64Currency precision (for example 100 for cents).
CallBackURLstringWebhook URL when the condition is met.
DescriptionstringOptional description for the monitor.
2

Save the monitor ID

Use monitor.MonitorID to retrieve or update the monitor later.
3

Response

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"
}
FieldTypeDescription
monitor_idstringUnique ID for the monitor.
balance_idstringBalance being monitored.
conditionobjectThreshold rule you passed in the request.
call_back_urlstringWebhook URL for notifications.
descriptionstringDescription for the monitor.
created_atstringDate 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.