v1

latestOpenAPI 3.0.02026-07-17339.2 KB

ledger

List Balances

List an Account Balances

Retrieve a list of the Balances from the Account with the given ID.

get/balances

Query parameters

accountstring required

Example:Alice

The ID of the Account

Response

currencystring required

Currencies are the types of commodities kept in balances. If not otherwise specified, any currency can be used and will work just fine. It can be a crypto asset, loyalty points, monetary currencies, gold, or anything you can think of.

amountinteger required

Amount of this balance. A positive integer representing the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

Example response

[
  {
    "currency": "usd",
    "amount": 1000
  }
]