GET
/
balance-monitors
/
{monitor_id}
curl --request GET \
  --url http://localhost:5001/balance-monitors/{monitor_id}

{
  "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "condition": {
    "field": "debit_balance",
    "operator": ">",
    "value": 100000
  },
  "call_back_url": "https://api.myapp.com/balancemonitor",
  "description": "",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}

​
Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: Secure your Blnk server

​
Path

​
monitor_id
string
required

The unique id of the balance monitor you want to view. Leave empty to view all balance monitors in your Blnk Ledger.

​
Response

​
balance_id
string

Specifies the balance id of the ledger balance to be monitored.

​
condition
object

Defines the criteria for monitoring a specific balance type.

​
call_back_url
string

Specifies the URL where notifications will be sent when the balance crosses the defined threshold.

​
description
string

A brief explanation of the purpose of the monitor.

​
created_at
string

Date and time when the monitor was created.

curl --request GET \
  --url http://localhost:5001/balance-monitors/{monitor_id}

{
  "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "condition": {
    "field": "debit_balance",
    "operator": ">",
    "value": 100000
  },
  "call_back_url": "https://api.myapp.com/balancemonitor",
  "description": "",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}

​
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.