Skip to main content
GET
/
balances
/
{balance_id}
/
lineage
View balance lineage
curl --request GET \
  --url http://localhost:5001/balances/{balance_id}/lineage \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.getLineage to inspect a balance’s fund breakdown.
blnk.LedgerBalances.getLineage
const response = await blnk.LedgerBalances.getLineage(
  'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
);
FieldDescription
balanceIdBalance ID with fund lineage enabled.

​
Response shape

200 OK
{
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "aggregate_balance_id": "bln_aggregate_shadow_balance_id",
  "total_with_lineage": "7500",
  "providers": [
    {
      "provider": "stripe",
      "amount": "10000",
      "available": "7500",
      "spent": "2500",
      "shadow_balance_id": "bln_shadow_balance_id"
    }
  ]
}
FieldDescription
balance_idBalance you queried.
aggregate_balance_idInternal aggregate balance ID for combined provider funds.
total_with_lineageTotal available funds tracked by lineage (minor units, string).
providersProvider-by-provider breakdown of received and spent funds.

Fund lineage

Tagged funds and allocation strategies.

View balance lineage

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.