Accounts

Accounts

Last updated: (timestamp)

Accounts

accounts

Methods

Get account

get/v1/accounts/{account_token}

Get account configuration such as spend limits.

Update 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.

List accounts

get/v1/accounts

List account configurations.

Get account's available spend limits

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

Accountobject

ShowShow

tokenstring

Globally unique identifier for the account. This is the same as the account_token returned by the enroll endpoint. If using this parameter, do not include pagination.

formatuuid

createdstring

Timestamp of when the account was created.

formatdate-time

spend_limitobject

Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. Any charges to a card owned by this account will be declined once their transaction volume has surpassed the value in the applicable time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit feature is disabled.

Hide ParametersShow Parameters

dailynumber

Daily spend limit (in cents).

minimum0

lifetimenumber

Total spend limit over account lifetime (in cents).

minimum0

monthlynumber

Monthly spend limit (in cents).

minimum0

stateenum

Accepts one of the following: "ACTIVE", "PAUSED", "CLOSED"

Account state:

• ACTIVE - Account is able to transact and create new cards.
• PAUSED - Account will not be able to transact or create new cards. It can be set back to ACTIVE.
• CLOSED - Account will not be able to transact or create new cards. CLOSED accounts are unable to be transitioned to ACTIVE or PAUSED states. Accounts can be manually set to CLOSED, or this can be done by Lithic due to failure to pass KYB/KYC or for risk/compliance reasons. Please contact support@lithic.com if you believe this was done by mistake.

Hide ParametersShow Parameters

"ACTIVE"

"PAUSED"

"CLOSED"

account_holderobject

optional

Hide ParametersShow Parameters

tokenstring

Globally unique identifier for the account holder.

business_account_tokenstring

Only applicable for customers using the KYC-Exempt workflow to enroll authorized users of businesses. Account_token of the enrolled business associated with an enrolled AUTHORIZED_USER individual.

emailstring

Email address.

phone_numberstring

Phone number of the individual.

auth_rule_tokensarray of string

optional

deprecated

List of identifiers for the Auth Rule(s) that are applied on the account. This field is deprecated and will no longer be populated in the account_holder object. The key will be removed from the schema in a future release. Use the /auth_rules endpoints to fetch Auth Rule information instead.

cardholder_currencystring

optional

3-character alphabetic ISO 4217 code for the currency of the cardholder.

verification_addressobject

optional

deprecated

Hide ParametersShow Parameters

address1string

Valid deliverable address (no PO boxes).

citystring

City name.

countrystring

Country name. Only USA is currently supported.

postal_codestring

Valid postal code. Only USA postal codes (ZIP codes) are currently supported, entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.

statestring

Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.

address2string

optional

Unit or apartment number (if applicable).

Account Spend Limits

AccountSpendLimitsobject

ShowShow

available_spend_limitobject

Hide ParametersShow Parameters

dailynumber

optional

The available spend limit (in cents) relative to the daily limit configured on the Account (e.g. 100000 would be a $1,000 limit).

lifetimenumber

optional

The available spend limit (in cents) relative to the lifetime limit configured on the Account.

monthlynumber

optional

The available spend limit (in cents) relative to the monthly limit configured on the Account.

spend_limitobject

optional

Hide ParametersShow Parameters

dailynumber

optional

The configured daily spend limit (in cents) on the Account.

lifetimenumber

optional

The configured lifetime spend limit (in cents) on the Account.

monthlynumber

optional

The configured monthly spend limit (in cents) on the Account.

spend_velocityobject

optional

Hide ParametersShow Parameters

dailynumber

optional

Current daily spend velocity (in cents) on the Account. Present if daily spend limit is set.

lifetimenumber

optional

Current lifetime spend velocity (in cents) on the Account. Present if lifetime spend limit is set.

monthlynumber

optional

Current monthly spend velocity (in cents) on the Account. Present if monthly spend limit is set.