Date String Parameters

date-time

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

ending_before

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

1 to 100. Defaults to 50. Page size (for pagination).

starting_after

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 Structure

200 OK

• object
  • data (array of objects)
    • account_hodler (object)
      • auth_rule_tokens (array of strings, deprecated)
      • cardholder_currency (string 3-character alphabetic ISO 4217 code)
      • spend_limit (object)
        • daily (integer)
        • monthly (integer)
        • lifetime (integer)
      • state (string, required)
      • substatus (string | null, enum)
      • comment (string)
      • token (uuid, required)
      • created (date-time | null, required)
      • has_more (boolean, required)

Spend Limit Object

• state (Account state)

  • ACTIVE - Account can transact and create new cards.
  • PAUSED - Account cannot transact or create new cards but can return to ACTIVE.
  • CLOSED - Account cannot transact or create new cards and cannot transition back to ACTIVE or PAUSED.

• substatus (Account state substatus values)

  • FRAUD_IDENTIFIED
  • SUSPICIOUS_ACTIVITY
  • RISK_VIOLATION
  • END_USER_REQUEST
  • ISSUER_REQUEST
  • NOT_ACTIVE
  • INTERNAL_REVIEW
  • OTHER

• comment (Additional context or information related to the account)

Example Request:

curl --request GET \
     --url 'https://sandbox.lithic.com/v1/accounts?page_size=50' \
     --header 'accept: application/json'

Example Response:

{
  "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
}