Ledger balances
Get balance by indicator
Retrieve a balance by its indicator with the Go SDK.
GET
/balances/indicator/{indicator}/currency/{currency}Use client.LedgerBalance.GetByIndicator to look up an internal balance by indicator and currency.
Call the method
balance, _, _ := client.LedgerBalance.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). |
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
}Go response (*blnkgo.LedgerBalance)
| Field | Type | Description |
|---|---|---|
BalanceID | string | Unique ID for the balance. |
Indicator | string | Indicator you passed in the request. |
Currency | string | Currency you passed in the request. |
Balance | *big.Int | Current net amount. |
LedgerID | string | Ledger this balance belongs to. |
CreatedAt | time.Time | Date and time the balance was created. |
MetaData | MetaData | Optional metadata object. |