Skip to main content
GET
/
balance-monitors
curl --request GET \
  --url https://api.blnk.io/balance-monitors \
  --header 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "monitor_id": "mon_1234567890",
    "balance_id": "bln_0987654321",
    "condition": {
      "field": "balance",
      "operator": "<",
      "value": 100,
      "precision": 100,
      "precise_value": "10000"
    },
    "description": "Low balance alert",
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "monitor_id": "mon_9876543210",
    "balance_id": "bln_1234567890",
    "condition": {
      "field": "credit_balance",
      "operator": ">",
      "value": 10000,
      "precision": 100,
      "precise_value": "1000000"
    },
    "description": "High credit balance alert",
    "created_at": "2024-01-15T11:00:00Z"
  },
  {
    "monitor_id": "mon_5555555555",
    "balance_id": "bln_0987654321",
    "condition": {
      "field": "inflight_balance",
      "operator": ">",
      "value": 5000,
      "precision": 100,
      "precise_value": "500000"
    },
    "description": "High pending transactions alert",
    "created_at": "2024-01-15T12:00:00Z"
  }
]
Retrieve a list of all balance monitors configured in your Blnk instance. This endpoint returns all monitors across all balances.

​
Response

Returns an array of balance monitor objects.
​
monitors
array
Array of balance monitor objects
curl --request GET \
  --url https://api.blnk.io/balance-monitors \
  --header 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "monitor_id": "mon_1234567890",
    "balance_id": "bln_0987654321",
    "condition": {
      "field": "balance",
      "operator": "<",
      "value": 100,
      "precision": 100,
      "precise_value": "10000"
    },
    "description": "Low balance alert",
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "monitor_id": "mon_9876543210",
    "balance_id": "bln_1234567890",
    "condition": {
      "field": "credit_balance",
      "operator": ">",
      "value": 10000,
      "precision": 100,
      "precise_value": "1000000"
    },
    "description": "High credit balance alert",
    "created_at": "2024-01-15T11:00:00Z"
  },
  {
    "monitor_id": "mon_5555555555",
    "balance_id": "bln_0987654321",
    "condition": {
      "field": "inflight_balance",
      "operator": ">",
      "value": 5000,
      "precision": 100,
      "precise_value": "500000"
    },
    "description": "High pending transactions alert",
    "created_at": "2024-01-15T12:00:00Z"
  }
]

​
Use Cases

​
Monitor Dashboard

Build a dashboard showing all active monitoring rules across your system.

​
Audit and Compliance

Retrieve all monitors for compliance reporting and audit trails.

​
System Health Checks

Verify that critical balance monitors are properly configured.

​
Bulk Monitor Management

Retrieve all monitors to perform bulk updates or deletions.

​
Notes

  • This endpoint returns all monitors without pagination
  • For large systems with many monitors, consider using the balance-specific endpoint
  • Monitors are cached for performance, with a 5-minute TTL
  • The response includes monitors for all balances across all ledgers

Build docs developers (and LLMs) love

Get started for freeTalk to us