Balance

Get balances

Changed on

Get the balances for a given financial account.

get/v1/financial_accounts/{financial_account_token}/balances

Request

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

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for financial account.

Query parameters

balance_datestring date-time

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

last_transaction_event_tokenstring uuid

Balance after a given financial event occured. Note: if an account receives multiple events around the same time whose financial impacts cancel out, a balance lookup by one of those event tokens may return 404, since their combined impact on the account is zero.

Response

OK

has_moreboolean required

More data exists.

Example response

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

Changes

  • 17d2fbc28992Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status