Balance

Get the funds available for card spend backed by a given Security Account, along with the balances that amount is derived from.

Open to buy is the amount Lithic authorizes card spend against. It is not a stored balance, so it is recalculated on every request from the Security Account, the funds held against spend Lithic has already paid out to the networks on your behalf, and the spend that has not yet been collected. The accounts that feed the calculation depend on your program setup, so summary.settled_funds is null outside Commercial Charge.

Supported for Commercial Charge, Dynamic Reserve, and Secured Charge programs. Returns 404 if financial_account_token is not a Security Account you own, or if your program setup does not use an open to buy calculation.

get/v1/financial_accounts/{financial_account_token}/open_to_buy

Request

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

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for the Security Account to price

Response

OK

open_to_buyinteger required

Funds available for card spend backed by this Security Account, in the currency's smallest unit (e.g., cents for USD). Equal to the sum of the amounts in summary, and reaches zero once outstanding spend has consumed all available funding

Example response

{
  "open_to_buy": 350000,
  "summary": {
    "security": 300000,
    "settled_funds": 300000,
    "total_outstanding_spend": -250000
  }
}

Changes