Ledger balances

View balance lineage

See a balance's provider breakdown when fund lineage is enabled with the Go SDK.

GET/balances/{balance_id}/lineage

Use client.LedgerBalance.GetLineage to inspect a balance’s fund breakdown.

Call the method

lineage, _, _ := client.LedgerBalance.GetLineage(
	"bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
)
FieldTypeDescription
balanceIDstringBalance ID with fund lineage enabled.

Response

{
  "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"
    }
  ]
}

Go response (*blnkgo.BalanceLineage)

FieldTypeDescription
BalanceIDstringBalance you queried.
AggregateBalanceIDstringInternal aggregate balance ID for combined provider funds.
TotalWithLineage*big.IntTotal available funds tracked by lineage (minor units).
Providers[]
LineageProviderBreakdown
Provider-by-provider breakdown of received and spent funds.
Providers.
Provider
stringProvider name (for example stripe).
Providers.
Amount
*big.IntTotal amount received from the provider (minor units).
Providers.
Available
*big.IntRemaining available amount (minor units).
Providers.
Spent
*big.IntAmount spent from the provider (minor units).
Providers.
ShadowBalanceID
stringShadow balance ID for this provider’s funds.