Skip to main content
GET
/
v1
/
card-issuer
/
customers
/
aggregate-balances
curl -X GET 'https://crypto-api.yativo.com/api/v1/card-issuer/customers/aggregate-balances' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "success": true,
  "data": {
    "by_currency": [
      {
        "currency": "USD",
        "total_ledger_balance": 12345.67,
        "total_available_balance": 11890.23,
        "total_pending_balance": 455.44,
        "customer_count": 42,
        "realtime_count": 40,
        "on_chain_count": 1
      },
      {
        "currency": "EUR",
        "total_ledger_balance": 4321.00,
        "total_available_balance": 4321.00,
        "total_pending_balance": 0.00,
        "customer_count": 15,
        "realtime_count": 15,
        "on_chain_count": 0
      },
      {
        "currency": "GBP",
        "total_ledger_balance": 890.50,
        "total_available_balance": 820.00,
        "total_pending_balance": 70.50,
        "customer_count": 7,
        "realtime_count": 6,
        "on_chain_count": 1
      }
    ],
    "total_customers": 64,
    "customers_with_wallets": 63,
    "fetched_at": "2026-05-12T14:30:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yativo.com/llms.txt

Use this file to discover all available pages before exploring further.

Balances are fetched live from the blockchain and reflect the actual token balance held in each customer’s account wallet. This call queries each wallet individually and may take a few seconds for large programs.
​
Authorization
string
required
Bearer token: Bearer YOUR_ACCESS_TOKEN
Use this endpoint to see the total float across your card issuer program without querying each customer individually. Results are grouped by currency (USD, EUR, GBP) and include a count of wallets successfully fetched. 
curl -X GET 'https://crypto-api.yativo.com/api/v1/card-issuer/customers/aggregate-balances' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "success": true,
  "data": {
    "by_currency": [
      {
        "currency": "USD",
        "total_ledger_balance": 12345.67,
        "total_available_balance": 11890.23,
        "total_pending_balance": 455.44,
        "customer_count": 42,
        "realtime_count": 40,
        "on_chain_count": 1
      },
      {
        "currency": "EUR",
        "total_ledger_balance": 4321.00,
        "total_available_balance": 4321.00,
        "total_pending_balance": 0.00,
        "customer_count": 15,
        "realtime_count": 15,
        "on_chain_count": 0
      },
      {
        "currency": "GBP",
        "total_ledger_balance": 890.50,
        "total_available_balance": 820.00,
        "total_pending_balance": 70.50,
        "customer_count": 7,
        "realtime_count": 6,
        "on_chain_count": 1
      }
    ],
    "total_customers": 64,
    "customers_with_wallets": 63,
    "fetched_at": "2026-05-12T14:30:00.000Z"
  }
}

​
Response fields

FieldDescription
by_currencyArray of balance summaries, one entry per currency in your program
by_currency[].currencyCurrency code (USD, EUR, GBP)
by_currency[].total_ledger_balanceSum of total token balances across all wallets for this currency
by_currency[].total_available_balanceSum of spendable balances (ledger minus pending holds)
by_currency[].total_pending_balanceSum of amounts held for authorized-but-unsettled transactions
by_currency[].customer_countTotal customers with this card currency (deployed wallets)
by_currency[].realtime_countWallets whose balance came from live card notifications
by_currency[].on_chain_countWallets where balances were fetched directly from the blockchain (no pending info available)
total_customersTotal customers across all currencies
customers_with_walletsCustomers whose account wallet has been deployed
fetched_atISO 8601 timestamp of when the response was generated
When on_chain_count > 0 for a currency, the total_available_balance for those wallets equals their total_ledger_balance — pending transaction holds are not visible from the blockchain alone. total_available_balance may be slightly overstated in that case.