Get open to buy
Changed onGet 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.
Request
- Base URLhttps://sandbox.lithic.com
- URLhttps://sandbox.lithic.com/v1/financial_accounts/{financial_account_token}/open_to_buy
- AuthAPI key in header Authorization
Path parameters
Globally unique identifier for the Security Account to price
Response
OK
Example response
{
"open_to_buy": 350000,
"summary": {
"security": 300000,
"settled_funds": 300000,
"total_outstanding_spend": -250000
}
}Changes
- info
endpoint added
- info