Lithic API Documentation | Accounts › Get Account S Available Spend Limits

Accounts

accounts

Methods

List Accounts -> CursorPage<

Account

get/v1/accounts

List account configurations.

Get Account ->

Account

get/v1/accounts/{account_token}

Get account configuration such as spend limits.

path Parameters

account_token: string

(format: uuid)

Response fields

Account

Request example

curl https://api.lithic.com/v1/accounts/$ACCOUNT_TOKEN \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "token": "b68b7424-aa69-4cbc-a946-30d90181b621",
  "created": "2019-12-27T18:11:19.117Z",
  "spend_limit": {
    "daily": 10000,
    "lifetime": 100000,
    "monthly": 40000
  },
  "state": "ACTIVE",
  "account_holder": {
    "token": "95e5f1b7-cfd5-4520-aa3c-2451bab8608d",
    "business_account_token": "e87db14a-4abf-4901-adad-5d5c9f46aff2",
    "email": "[email protected]",
    "phone_number": "+15555555555"
  },
  "auth_rule_tokens": [
    "string"
  ],
  "cardholder_currency": "USD",
  "comment": "comment",
  "substatus": "FRAUD_IDENTIFIED",
  "verification_address": {
    "address1": "124 Old Forest Way",
    "city": "Seattle",
    "country": "USA",
    "postal_code": "98109",
    "state": "WA",
    "address2": "Apt 21"
  }
}

Update Account ->

Account

patch/v1/accounts/{account_token}

Update account configuration such as state or spend limits. Can only be run on accounts that are part of the program managed by this API key. Accounts that are in the PAUSED state will not be able to transact or create new cards.

Get Account S Available Spend Limits ->

AccountSpendLimits

get/v1/accounts/{account_token}/spend_limits

Get an Account's available spend limits, which is based on the spend limit configured on the Account and the amount already spent over the spend limit's duration. For example, if the Account has a daily spend limit of $1000 configured, and has spent $600 in the last 24 hours, the available spend limit returned would be $400.

path Parameters

account_token: string

(format: uuid)

Response fields

AccountSpendLimits

Request example

curl https://api.lithic.com/v1/accounts/$ACCOUNT_TOKEN/spend_limits \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "available_spend_limit": {
    "daily": 100000,
    "lifetime": 300000,
    "monthly": 200000
  },
  "spend_limit": {
    "daily": 500000,
    "lifetime": 500000,
    "monthly": 500000
  },
  "spend_velocity": {
    "daily": 40000,
    "lifetime": 20000,
    "monthly": 30000
  }
}

Domain types

Account = { token, created, spend_limit, 7 more... }

AccountSpendLimits = { available_spend_limit, spend_limit, spend_velocity }