Ledger balances
View balance monitor details
See the details of one or all balance monitors.
GET
/
balance-monitors
/
{monitor_id}
curl -X GET "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"
}
{
"error": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found",
"error_detail": {
"code": "BAL_MONITOR_NOT_FOUND",
"message": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found"
}
}
If you’re using the auto-provisioned
Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.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: Scoped API keys and Secure your Blnk server.
Path
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
string
Specifies the balance id of the ledger balance to be monitored.
object
Defines the criteria for monitoring a specific balance type.
Show child attributes
Show child attributes
string
Specifies the balance type to be monitored. Every ledger balance has 6 balance types -
balance, inflight_balance, credit_balance, inflight_credit_balance , debit_balance, and inflight_debit_balance.string
Defines the comparison operator to apply. Accepted values: > (greater than), < (less than), or = (equal to).
integer
The threshold amount that triggers the balance monitor.
string
Specifies the URL where notifications will be sent when the balance crosses the defined threshold.
string
A brief explanation of the purpose of the monitor.
string
Date and time when the monitor was created.
curl -X GET "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"
}
{
"error": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found",
"error_detail": {
"code": "BAL_MONITOR_NOT_FOUND",
"message": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found"
}
}
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.Was this page helpful?
⌘I
curl -X GET "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"
}
{
"error": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found",
"error_detail": {
"code": "BAL_MONITOR_NOT_FOUND",
"message": "Monitor with ID 'mon_c5d9e2a1-7b4f-4a3c-9e8d-1f6a2b4c8d30' not found"
}
}