Ledger balances

View balance monitor details

Get one balance monitor with the Go SDK.

GET/balance-monitors/{monitor_id}

Use client.BalanceMonitor.Get to retrieve a balance monitor by ID.

Call the method

monitor, _, _ := client.BalanceMonitor.Get(
	"mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
)
FieldTypeDescription
monitorIDstringMonitor ID to retrieve.

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.
Condition.
Field
stringBalance field to watch (for example credit_balance, debit_balance, balance).
Condition.
Operator
MonitorCondition
Operators
Comparison operator: >, <, =, !=, >=, <=.
Condition.
Value
int64Threshold amount.
Condition.
Precision
int64Currency precision (for example 100 for cents).
CallBackURLstringWebhook URL for notifications.
DescriptionstringDescription for the monitor.
CreatedAtstringDate and time when the monitor was created.