Overview

You can now retrieve the open to buy for a Security Account with the new Get Open to buy endpoint.

Open to buy is the overall program limi Lithic authorizes card spend against. The endpoint returns that amount together with the balances it is derived from, so you can see how much your end users can still spend across the program and why.

Details

Only for Secured constructs with Security Accounts. If your program does not have a financial_account with type = SECURITY, this API does not apply.
Calculated on request. Open to buy is not a stored balance. Lithic recalculates it on every request from three inputs:
- The available balance of the Security Account
- Funds that have moved out of the Security Account to cover settled card spend
- Authorized card spend that has not yet been collected from your business clients (outstanding spend)

Request/response schema

Request

Parameter	Type	Required	Description
`financial_account_token`	string (uuid)	Yes	Globally unique identifier. This endpoint only works with your Security account

Response

200 OK

Field	Type	Required	Description
`open_to_buy`	integer	Yes	Funds available in cents for card spend backed by this Security Account. Equal to the sum of the amounts in `summary`, and reaches zero once outstanding spend has consumed all available funding
`summary`	object	Yes	Balances that `open to buy` ^ is derived from
`summary.security`	integer	Yes	Available balance in cents of the Security Account backing card spend
`summary.settled_funds`	integer	Yes	Funding in cents that has moved out of the Security Account to cover card spend Lithic has already paid out to the networks. Open to buy counts it alongside `security`
`summary.total_outstanding_spend`	integer	Yes	Card spend in cents that has not yet been collected. Reported as a negative amount, because it reduces open to buy

Example response

{
  "open_to_buy": 35000000,
  "summary": {
    "security": 30000000,
    "settled_funds": 30000000,
    "total_outstanding_spend": -25000000
  }
}

Error responses

Status	Meaning
`401`	Unauthorized
`404`	`financial_account_token` is not a Security Account you own, or your program does not use this endpoint
`422`	Unprocessable `financial_account_token`
`429`	Too many requests

Release Timeline

Production availability: Available now

User Impact

This change is additive only. Learn more about Credit at Lithic.

If you have any questions or concerns, please contact us via the HELP link in your Lithic Dashboard.

The Lithic changelog has an RSS feed! To monitor for new update announcements, subscribe with your preferred RSS reader.