Skip to main content
POST
/
balance-monitors
Create Balance Monitor
curl --request POST \
  --url http://localhost:5001/balance-monitors \
  --header 'Content-Type: application/json' \
  --header 'X-blnk-key: <api-key>' \
  --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
  },
  "description": "",
  "call_back_url": "https://api.myapp.com/balancemonitor",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-blnk-key
string
header
required

Body

application/json
​
balance_id
string
required
​
condition
Condition · object
required
Example:
{
  "field": "debit_balance",
  "operator": ">",
  "value": 100000
}
​
call_back_url
string
required

Response

201 - application/json; charset=utf-8

Created

​
monitor_id
string
required
​
balance_id
string
required
​
condition
Condition · object
required
Example:
{
  "field": "debit_balance",
  "operator": ">",
  "value": 100000
}
​
description
string
required
​
call_back_url
string
required
​
created_at
string
required