Skip to main content
POST
/
proxy
/
balances
curl -X POST "https://api.cloud.blnkfinance.com/proxy/balances?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "currency": "USD"
  }'

{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_debit_balance": 0,
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "identity_id": "",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "currency": "USD",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": null
}

Documentation Index

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

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

Create a new balance in a ledger. Balances track amounts in a specific currency and can be used as sources or destinations for transactions.
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/balances?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "currency": "USD"
  }'
​
Authorization
string
required
Bearer token for authentication. Format: Bearer <access_token>. Your OAuth key must include proxy:write scope (or *).
​
ledger_id
string
required
The ID of the ledger to create the balance in.
​
identity_id
string
The ID of the ledger to create the balance in.
​
currency
string
required
Currency code for the balance (e.g., USD, EUR, GBP).
​
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

{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_debit_balance": 0,
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "identity_id": "",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "currency": "USD",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": null
}
​
balance_id
string
required
Unique identifier for the created balance.
​
ledger_id
string
required
The ID of the ledger this balance belongs to.
​
currency
string
required
Currency code for the balance.
​
balance
number
required
Current balance amount.
​
inflight_balance
number
required
Balance amount for in-flight transactions.
​
credit_balance
number
required
Total credit balance.
​
debit_balance
number
required
Total debit balance.
​
inflight_credit_balance
number
required
In-flight credit balance.
​
inflight_debit_balance
number
required
In-flight debit balance.
​
identity_id
string
ID of the identity associated with this balance, if any.
​
created_at
timestamp
required
ISO 8601 formatted timestamp of when the balance was created.
​
meta_data
object
The metadata object attached to the balance, if provided.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at support@blnkfinance.com or send us a message here.