v1

latestOpenAPI 3.1.02026-07-247328324.6 KB

Sales

Get ledger balances

get/programs/{id}/balances

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Query parameters

currencystring

ISO 4217 currency code

Example:USD

ISO 4217 currency code

Response

Successful operation

Example response

{
  "data": [
    {
      "currency": "USD",
      "updated_at": "2024-01-15T10:30:00Z",
      "settled_balance": 10000,
      "settled_balance_usd": 10000,
      "pending_increases": 10000,
      "pending_increases_usd": 10000,
      "pending_decreases": 10000,
      "pending_decreases_usd": 10000
    }
  ]
}