A customer can hold funds across several Passport Accounts. Rather than fetching each account's balance and adding them up yourself, the aggregated balance gives you one unified figure — the customer's total available balance across all eligible accounts. Clearing (FBO) accounts are excluded, so the number reflects only funds the customer can actually use.

Use it to show a customer's overall available funds at a glance, or to check spending power before you schedule a payout.

Retrieve the aggregated balance

Make a GET request to /v1/customer/id/{id}/aggregateBalance (or /v1/customer/externalId/{externalId}/aggregateBalance).

Request

GET /v1/customer/id/4052981/aggregateBalance
PromiseMode: NEVER

Response

{
  "totalAvailableBalance": "75.62",
  "accounts": [
    {
      "resourceName": "account",
      "url": "/v1/customer/id/4001203/account/id/4000996",
      "id": 4000996
    },
    {
      "resourceName": "account",
      "url": "/v1/customer/id/4001203/account/id/4001003",
      "id": 4001003
    }
  ]
}

Field	Description
`totalAvailableBalance`	Combined available balance across all eligible accounts (FBO accounts excluded).
`accounts[]`	The accounts included in the total, each with its `id` and `url`.

The aggregated balance sums available balances, so it already accounts for holds and pending activity. For a single account's posted debits and credits with a running balance, use the Account ledger.

Retrieve Aggregated Balance

Retrieve the aggregated balance

See also