Skip to main content
GET
/
balances
/
{balance_id}
View balance details
curl --request GET \
  --url http://localhost:5001/balances/{balance_id} \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.get to retrieve a balance by its balance ID.
blnk.LedgerBalances.get
const response = await blnk.LedgerBalances.get(
  'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
);
FieldDescription
idBalance ID to retrieve.

​
Response shape

200 OK
{
  "balance": 0,
  "inflight_balance": 0,
  "credit_balance": 0,
  "inflight_credit_balance": 0,
  "debit_balance": 0,
  "inflight_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
}
FieldDescription
balance_idUnique ID for the balance.
balanceCurrent net amount.
currencyCurrency or asset class.
credit_balanceTotal amount moved into the balance.
debit_balanceTotal amount moved out of the balance.

View balance docs

Balance concepts and setup.

View balance details

HTTP request and response schema.

​
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.