Balance

List balances

Changed on

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

get/v1/balances

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/balances
  • Auth
    API key in header Authorization

Query parameters

account_tokenstring uuid

List balances for all financial accounts of a given account_token.

business_account_tokenstring uuid

List balances for all financial accounts of a given business_account_token.

balance_datestring date-time

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

financial_account_type'ISSUING' | 'OPERATING' | 'RESERVE' | 'SECURITY'

List balances for a given Financial Account type.

Response

OK

has_moreboolean required

More data exists.

Example response

{
  "data": [
    {
      "financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Changes

  • fac001c63373Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • warning

      added the new CARD enum value to the // response property for the response status

    • warning

      added the new PROGRAM_RECEIVABLES enum value to the // response property for the response status