Accounts

Get account balance

GEThttps://api.firstleeward.com/v0/accounts/:id/balance

Retrieves the account financial position including total asset value, liabilities, and net available balance. Use GET /accounts/:id/assets for per-asset breakdown. All values are in the project's billing currency (see the currency field).

Authorizations

Authorizationstring · headerrequired

API key as Bearer token, e.g. Bearer YOUR_API_KEY

Headers

Leeward-Versionenum<string>required

API version (YYYY-MM-DD). Available option: 2026-09-18

Path Parameters

idstring<uuid>required

Account ID

Response

200Account balance: total asset value, liabilities, and net position. In User-Funded projects and Program-Funded projects on Managed authorization, First Leeward authorizes each card transaction against these balances. Under External authorization this endpoint is not the authorization source: First Leeward holds no per-user asset balance, `availableBalance` reflects only First Leeward-side card debt and is not spendable, and your own ledger is authoritative.
currencystringrequired

Currency for all monetary values - the billing currency of the project's card program

totalAssetValuenumberrequired

Sum of all asset values backing the account.

totalLiabilitiesnumberrequired

Sum of all liabilities. Can be negative when refunds or settlement payments exceed outstanding card debt.

availableBalancenumberrequired

Net balance: totalAssetValue - totalLiabilities. In User-Funded projects and Program-Funded projects on Managed authorization, this is the spendable figure the next card swipe is authorized against and the primary number to surface to cardholders. Not a spendable figure under External authorization - see the endpoint description.

assetsobjectrequired
Show child attributes
cryptonumber | nullrequired

Value of the crypto credited to this account, in the response currency. Null for accounts crypto does not fund (user accounts on PROGRAM_FUNDED projects).

fiatnumber | nullrequired

Value of the fiat bank transfers credited to this account, in the response currency. Only the project master account can be funded by bank transfer, so this is null on every other account.

virtualnumber | nullrequired

Value of virtual asset balances on this account, in the response currency. Null when virtual assets are not applicable to the project.

liabilitiesobjectrequired
Show child attributes
cardDebtobjectrequired
Show child attributes
pendingnumberrequired

Authorized card spend not yet cleared. Reduces available balance.

clearednumberrequired

Cleared card spend not yet settled. May be negative when over-settled.

totalnumberrequired

Total outstanding card debt (pending + cleared).

depositFeesnumber | nullrequired

Deposit fees charged on deposits credited to this account, in the response currency. Only applies to the master collateral account of a PROGRAM_FUNDED project; null on user accounts.

404Account not found
errorobjectrequired
Show child attributes
codestringrequired
messagestringrequired
detailobject | nullrequired