Ledger balances

List balance monitors

List balance monitors with the Go SDK.

GET/balance-monitors

Use client.BalanceMonitor.List to retrieve all balance monitors.

Call the method

monitors, _, _ := client.BalanceMonitor.List()

This method takes no arguments.

Response

[
  {
    "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"
  }
]

Go response ([]blnkgo.MonitorDataResp)

FieldTypeDescription
MonitorIDstringUnique ID for the monitor.
BalanceIDstringBalance being monitored.
ConditionMonitorConditionThreshold rule for the monitor.
CallBackURLstringWebhook URL for notifications.
DescriptionstringDescription for the monitor.
CreatedAtstringDate and time when the monitor was created.