Skip to main content
GET
/
balance-monitors
/
{monitor_id}
View balance monitor details
curl --request GET \
  --url http://localhost:5001/balance-monitors/{monitor_id} \
  --header 'X-blnk-key: <api-key>'
Use client.BalanceMonitor.Get to retrieve a balance monitor by ID.
1

Call the method

client.BalanceMonitor.Get
monitor, resp, err := client.BalanceMonitor.Get(
	"mon_e0e77b0c-4985-472a",
)
FieldTypeDescription
monitorIDstringMonitor ID to retrieve.
2

Use the monitor details

Read the returned monitor for the threshold condition, webhook URL, and linked BalanceID.
3

Response

200 OK
{
  "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 for the monitor.
condition.fieldstringBalance field to watch (for example credit_balance, debit_balance, balance).
condition.operatorstringComparison operator: >, <, =, !=, >=, <=.
condition.valuenumberThreshold amount.
condition.precisionnumberCurrency precision (for example 100 for cents).
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.

View balance monitor details

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.