Ledger balances

Get balance by indicator

Retrieve a balance by its indicator with the TypeScript SDK.

GET/balances/indicator/{indicator}/currency/{currency}

Use blnk.LedgerBalances.getByIndicator to look up an internal balance by indicator and currency.

Call the method

const response = await blnk.LedgerBalances.getByIndicator('@World', 'USD');

Field	Type	Description
`indicator`	`string`	Balance indicator (for example `@World`). The SDK URL-encodes this in the request path.
`currency`	`string`	Currency code (for example `USD`).

Save the balance ID

Use response.data.balance_id when you need the canonical ID for transactions or API calls that do not accept indicators.

Response

{
  "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",
  "indicator": "@World",
  "identity_id": "",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "currency": "USD",
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "meta_data": null
}

Field	Type	Description
`balance_id`	`string`	Unique ID for the balance.
`indicator`	`string`	Indicator you passed in the request.
`currency`	`string`	Currency you passed in the request.
`balance`	`number`	Current net amount.