Lithic API Documentation | Balances

Balances

balances

Methods

List Balances -> SinglePage<

Balance

get/v1/balances

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

query Parameters

account_token: string

Optional

(format: uuid)

List balances for all financial accounts of a given account_token.

balance_date: string

Optional

(format: date-time)

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

business_account_token: string

Optional

(format: uuid)

List balances for all financial accounts of a given business_account_token.

financial_account_type:

Optional

List balances for a given Financial Account type.

"ISSUING"

"OPERATING"

"RESERVE"

"SECURITY"

Response fields

data: Array<

Balance

has_more: boolean

More data exists.

Request example

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

200Example

{
  "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
}

Domain types

Balance = { available_amount, created, currency, 7 more... }

Balance