Skip to main content
POST
https://api.cloud.blnkfinance.com
/
proxy
/
ledgers
curl -X POST "https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "MyApp Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test – all test balances live here"
    }
  }'

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "MyApp Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test – all test balances and transactions live here"
  }
}
Create a new ledger to group balances and transactions. Ledgers help organize your financial data.
For in-depth information about Blnk’s ledger, balance, transaction, and identity APIs, see the Blnk Core docs.

​
Request structure

curl -X POST "https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "MyApp Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test – all test balances live here"
    }
  }'
​
Authorization
string
required
Bearer token for authentication. Format: Bearer <access_token>. Your OAuth key must include proxy:write scope (or *).
​
name
string
required
Name for the ledger.
​
meta_data
object
Optional metadata object for custom key-value data. Use a top-level key (e.g., your app name) to avoid conflicts.

​
Query parameters

​
instance_id
string
required
The Blnk Core instance ID to target. Find this in Blnk Cloud under Instances.

​
Response structure

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "MyApp Integration Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "description": "Ledger for integration test – all test balances and transactions live here"
  }
}
​
ledger_id
string
required
Unique identifier for the created ledger.
​
name
string
required
The name of the ledger.
​
created_at
timestamp
required
ISO 8601 formatted timestamp of when the ledger was created.
​
meta_data
object
The metadata object attached to the ledger, if provided.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at [email protected] or send us a message here.