curl --request PUT \
--url http:
--header 'Content-Type: application/json' \
--data '{
"balance_id" : "bln_0be360ca-86fe-457d-be43-daa3f966d8f0" ,
"condition" : {
"field" : "debit_balance" ,
"operator" : ">" ,
"value" : 100000
} ,
"call_back_url" : "https://api.myapp.com/balancemonitor"
} '
{
"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
Basic authentication header of the form — Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string of your username:password
.
Path
The unique id of the balance monitor you want to view. Leave empty to view all balance monitors in your Blnk Ledger.
Body
Specifies the balance id of the ledger balance to be monitored.
Defines the criteria for monitoring a specific balance type.
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
.
Defines the comparison operator to apply. Accepted values: > (greater than), < (less than), or = (equal to).
The threshold amount that triggers the balance monitor.
Specifies the URL where notifications will be sent when the balance crosses the defined threshold.
A brief explanation of the purpose of the monitor.
Response
All parameters from the request body also mean the same in the corresponding response JSON.
The unique id of the balance monitor.
Date and time when the monitor was created.
curl --request PUT \
--url http:
--header 'Content-Type: application/json' \
--data '{
"balance_id" : "bln_0be360ca-86fe-457d-be43-daa3f966d8f0" ,
"condition" : {
"field" : "debit_balance" ,
"operator" : ">" ,
"value" : 100000
} ,
"call_back_url" : "https://api.myapp.com/balancemonitor"
} '
{
"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 .
Get access to Blnk Cloud.
Manage your Blnk Ledger and explore advanced features (access control & collaboration, anomaly detection, secure storage & file management, etc.) in one dashboard.