Skip to content

List

List balances
get/v1/balances

Get the balances for a program, business, or a given end-user account

Query Parameters
account_tokenstring
optional

List balances for all financial accounts of a given account_token.

formatuuid
balance_datestring
optional

UTC date and time of the balances to retrieve. Defaults to latest available balances

formatdate-time
business_account_tokenstring
optional

List balances for all financial accounts of a given business_account_token.

formatuuid
financial_account_typeenum
optional
Accepts one of the following: "ISSUING", "OPERATING", "RESERVE"

List balances for a given Financial Account type.

Hide ParametersShow Parameters
"ISSUING"
"OPERATING"
"RESERVE"
Returns
dataarray of available_amountnumbercreatedstringcurrencystringfinancial_account_tokenstringfinancial_account_typeenumlast_transaction_event_tokenstringlast_transaction_tokenstringpending_amountnumbertotal_amountnumberupdatedstringBalance
has_moreboolean

More data exists.

Request example Request
curl https://api.lithic.com/v1/balances \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "data": [
    {
      "available_amount": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "financial_account_type": "ISSUING",
      "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
}