Skip to main content
GET
/
balances
/
{balance_id}
Balance from source
curl --request GET \
  --url http://localhost:5001/balances/{balance_id} \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.get to reconstruct a balance from its transactions.
blnk.LedgerBalances.get
const response = await blnk.LedgerBalances.get(
  'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
  { from_source: true },
);
FieldDescription
idBalance ID to compute from source.
from_sourceMust be true to reconstruct from transactions.

​
Response shape

200 OK
{
  "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
  }
}
FieldDescription
balance.balanceNet amount computed from all transactions.
balance.balance_idUnique ID for the balance.
balance.credit_balanceTotal computed from credit transactions.
balance.debit_balanceTotal computed from debit transactions.
balance.currencyCurrency of the balance.
balance.ledger_idLedger this balance belongs to.
balance.identity_idLinked identity, if any.
balance.created_atDate and time the balance was created.
balance.meta_dataOptional metadata on the balance.

Balance from source guide

Transaction-based balance computation.

Balance from source

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.