Ledger balances

View balance details

See the details of one or all balances.

GET/balances/{balance_id}

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.

Path

balance_idstringrequiredpath

Specifies the unique ID of the balance being retrieved. Leave empty to view all balances in your Blnk Ledger.

Query

with_queuedbooleandefault falsequery

Indicates whether to include the queued balance in the response.

/balances/{balance_id}?with_queued=true

curl -X GET "http://localhost:5001/balances/{balance_id}" \
  -H "X-blnk-key: <api-key>"

{
    "balance": 0,
    "inflight_balance": 0,
    "credit_balance": 0,
    "inflight_credit_balance": 0,
    "debit_balance": 0,
    "inflight_debit_balance": 0,
    "queued_credit_balance": 0,
    "queued_debit_balance": 0,
    "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
    "identity_id": "",
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "currency": "USD",
    "created_at": "2024-11-26T08:36:36.238244338Z",
    "meta_data": null
}

{
  "error": "Balance with ID 'bln_a3f8c2e1-9d4b-4f7a-b6e2-1c8d5f0a7b3e' not found",
  "error_detail": {
    "code": "BAL_NOT_FOUND",
    "message": "Balance with ID 'bln_a3f8c2e1-9d4b-4f7a-b6e2-1c8d5f0a7b3e' not found"
  }
}