List

List aggregate balances

get/v1/aggregate_balances

Get the aggregated balance across all end-user accounts by financial account type

Query Parameters

financial_account_typeenum

optional

Accepts one of the following: "ISSUING", "OPERATING", "RESERVE"

Get the aggregate balance for a given Financial Account type.

Hide ParametersShow Parameters

"ISSUING"

"OPERATING"

"RESERVE"

Returns

dataarray of available_amountnumbercreatedstringcurrencystringfinancial_account_typeenumlast_financial_account_tokenstringlast_transaction_event_tokenstringlast_transaction_tokenstringpending_amountnumbertotal_amountnumberupdatedstringAggregateBalance

has_moreboolean

More data exists.

Request example Request

curl https://api.lithic.com/v1/aggregate_balances \
    -H "Authorization: $LITHIC_API_KEY"

200 Example

{
  "data": [
    {
      "available_amount": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "financial_account_type": "ISSUING",
      "last_financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "last_transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "last_transaction_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pending_amount": 0,
      "total_amount": 0,
      "updated": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true
}