Skip to main content
GET
/
balance-monitors
/
balances
/
:balance_id
curl --request GET \
  --url https://api.blnk.io/balance-monitors/balances/bln_0987654321 \
  --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 for customer account",
  "created_at": "2024-01-15T10:30:00Z"
}
Retrieve all balance monitors associated with a specific balance ID. This is useful for viewing all alert rules configured for a particular account or balance.

​
Path Parameters

​
balance_id
string
required
The unique identifier of the balance whose monitors you want to retrieve

​
Response

Returns a balance monitor object or an array of monitors for the specified balance.
​
monitor_id
string
Unique identifier for the balance monitor
​
balance_id
string
The ID of the monitored balance
​
condition
object
The alert condition configuration
​
description
string
Optional description of the monitor
​
created_at
string
Timestamp when the monitor was created (ISO 8601 format)
curl --request GET \
  --url https://api.blnk.io/balance-monitors/balances/bln_0987654321 \
  --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 for customer account",
  "created_at": "2024-01-15T10:30:00Z"
}

​
Use Cases

​
Account Management

View all monitoring rules configured for a specific customer account or balance.

​
Monitor Configuration Review

Audit the alert conditions set up for a particular balance.

​
Troubleshooting

Check what monitors are active when investigating webhook notifications.

​
Balance-Specific Dashboards

Display monitoring rules alongside balance information in your application.

​
Notes

  • Multiple monitors can be configured for the same balance with different conditions
  • The response format may vary (single object vs. array) depending on the implementation
  • Monitors are cached for performance with a 5-minute TTL
  • This endpoint is more efficient than retrieving all monitors and filtering client-side
  • Each balance can monitor different fields (balance, debit_balance, credit_balance, etc.) simultaneously

Build docs developers (and LLMs) love

Get started for freeTalk to us