Lithic API Documentation | Accounts

Accounts

accounts

Methods

List Accounts -> CursorPage<

Account

get/v1/accounts

List account configurations.

query Parameters

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response fields

data: Array<

Account

has_more: boolean

Whether there are more accounts to be retrieved.

Request example

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

200getAccounts

{
  "data": [
    {
      "cardholder_currency": "USD",
      "spend_limit": {
        "daily": 1000,
        "lifetime": 10000,
        "monthly": 4000
      },
      "state": "ACTIVE",
      "token": "b68b7424-aa69-4cbc-a946-30d90181b621",
      "created": "2024-01-11T19:50:36Z"
    }
  ],
  "has_more": false
}

Get Account ->

Account

get/v1/accounts/{account_token}

Get account configuration such as spend limits.

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.

Domain types

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

AccountSpendLimits = { available_spend_limit, spend_limit, spend_velocity }