Ledger balances

Balance from source

Compute balance directly from transactions with the TypeScript SDK.

GET/balances/{balance_id}

Use blnk.LedgerBalances.get with from_source set to true to reconstruct a balance from its transactions.

Call the method

const response = await blnk.LedgerBalances.get(
  'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
  {
    from_source: true,
  },
);

Field	Type	Description
`id`	`string`	Balance ID to compute from source.
`from_source`	`boolean`	Must be `true` to reconstruct from transactions.

Compare with stored balance

Use the computed amounts to audit or reconcile against the stored balance. Differences may indicate pending transactions or snapshot lag.

Response

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

Field	Type	Description
`balance.balance`	`number`	Net amount computed from all transactions.
`balance.balance_id`	`string`	Unique ID for the balance.
`balance.credit_balance`	`number`	Total computed from credit transactions.
`balance.debit_balance`	`number`	Total computed from debit transactions.
`balance.currency`	`string`	Currency of the balance.
`balance.ledger_id`	`string`	Ledger this balance belongs to.
`balance.identity_id`	`string`	Linked identity, if any.
`balance.created_at`	`string`	Date and time the balance was created.
`balance.meta_data`	`Record<string, unknown>`	Optional metadata on the balance.