Skip to content
Stainless Stainless Stainless SDKs

List

Get balances
get/v1/financial_accounts/{financial_account_token}/balances

Get the balances for a given financial account.

Path Parameters
financial_account_tokenstring
formatuuid
Query Parameters
balance_datestring
optional

UTC date of the balance to retrieve. Defaults to latest available balance

formatdate-time
last_transaction_event_tokenstring
optional

Balance after a given financial event occured. For example, passing the event_token of a $5 CARD_CLEARING financial event will return a balance decreased by $5

formatuuid
Returns
dataarray of object
Hide ParametersShow Parameters
tokenstring

Globally unique identifier for the financial account that holds this balance.

formatuuid
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_transaction_event_tokenstring

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

formatuuid
last_transaction_tokenstring

Globally unique identifier for the last financial 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).

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

Type of financial account.

Hide ParametersShow Parameters
"ISSUING"
"OPERATING"
"RESERVE"
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/financial_accounts/$FINANCIAL_ACCOUNT_TOKEN/balances \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "data": [
    {
      "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "available_amount": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "last_transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "last_transaction_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pending_amount": 0,
      "total_amount": 0,
      "type": "ISSUING",
      "updated": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true
}