List

List card aggregate balances

get/v1/cards/aggregate_balances

Get the aggregated card balance across all end-user accounts.

Query Parameters

account_tokenstring

optional

Cardholder to retrieve aggregate balances for.

business_account_tokenstring

optional

Business to retrieve aggregate balances for.

Returns

dataarray of object

Hide ParametersShow Parameters

available_amountnumber

Funds available for spend in the currency's smallest unit (e.g., cents for USD)

createdstring

Date and time for when the balance was first created.

formatdate-time

currencystring

3-character alphabetic ISO 4217 code for the local currency of the balance.

last_card_tokenstring

Globally unique identifier for the card that had its balance updated most recently

formatuuid

last_transaction_event_tokenstring

Globally unique identifier for the last transaction event that impacted this balance

formatuuid

last_transaction_tokenstring

Globally unique identifier for the last transaction that impacted this balance

formatuuid

pending_amountnumber

Funds not available for spend due to card authorizations or pending ACH release. Shown in the currency's smallest unit (e.g., cents for USD)

total_amountnumber

The sum of available and pending balance in the currency's smallest unit (e.g., cents for USD)

updatedstring

Date and time for when the balance was last updated.

formatdate-time

has_moreboolean

More data exists.

Request example Request

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

200 Example

{
  "data": [
    {
      "available_amount": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "last_card_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
}