API Basics

Learn about the Lithic API.

Authenticating

An API key is required to get started. Generate one in the account page.

Requests are authenticated with an API (secret) key with the following request header:

"Authorization: api-key YOUR_API_KEY"

Example

curl --request GET \
     --url 'http://api.lithic.com/v1/card?page=1&page_size=50' \
     --header 'Accept: application/json' \
     --header 'Authorization: api-key YOUR_API_KEY'

Errors

You can use this information to diagnose failed transactions and fine-tune your exception-handling capabilities.

400

[query] is not a valid parameterA parameter in the query given in the request does not match the valid queries for the endpoint

401

User has not been authenticatedInvalid or missing API key
API key is not activeThe API key used is no longer active
Could not find API keyThe API key provided is not associated with any user
Please provide API key in Authorization headerThe Authorization header is not in the request
Please provide API key in the form Authorization: api-key [api-key]The Authorization header is not formatted properly
Insufficient Privileges. Issuing API key requiredWrite access requires an Issuing API key. Please contact [email protected]
Insufficient privileges to create unlocked cards.Creating unlocked cards requires an additional privilege

422

Authorization failed (in simulation)An authorization fails when simulating an authorization

429

Rate limited, too many requests per secondUser has exceeded their per second rate limit
Rate limited, reached daily limitUser has exceeded their daily rate limit
Rate limited, too many keys triedOne IP has queried too many different API keys

500

Internal Server ErrorThere was a processing error on the server-side.

General Notes

Each entity is identified by its UUID token.

HTTP bodies must be valid JSON and the request header Content-Type must be application/json.

Amounts are all integers. They represent the number in cents (money amount is amount/100).

Any field we don’t have data for will show up as empty.

API GET responses are returned in a pagination wrapper in the form:

{
  "data": [
    // API OBJECTS
  ],
  "page": Integer,
  "total_entries": Integer,
  "total_pages": Integer
}

Did this page help you?