Account Controls

Learn how to set rules on accounts to control spend.

Account Configuration Schema (Enterprise)

{
  "account_token": String,
  "state": String,
  "spend_limit": {
      "daily": Integer,
      "monthly": Integer,
      "lifetime": Integer
  }
}
account_tokenGlobally unique identifier for the account
stateACTIVE or PAUSED
spend_limitSpend 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.

Get Account Configurations (Enterprise)

API reference: Get account configurations

Get account spend limits for one or all specified instance accounts. This endpoint can only be used on accounts that are part of the instance the calling API key manages. If account_token is supplied, this endpoint returns an AccountConfiguration object representing the account specified. Otherwise, a list of AccountConfiguration objects is returned. If querying for a single account, do not include pagination queries.

GET https://api.lithic.com/v1/account

Sample Request

curl https://api.lithic.com/v1/account \
    -H "Authorization: api-key YOUR_API_KEY"

Sample Response

{
  "data": [
    {
      "account_token": "b68b7424-aa69-4cbc-a946-30d90181b621",
      "state": "ACTIVE",
      "spend_limits": {
          "daily": 1000,
          "monthly": 4000,
          "lifetime": 10000
      }
    }
  ],
  "page": 1,
  "total_entries": 1,
  "total_pages": 1
}
account_tokenGlobally 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.
pageFor pagination. The default is one.
page_sizeFor pagination. The default value page size is 50 and the maximum is 1,000.
beginDate string in the form YYYY-MM-DD, only cards created after the specified date will be included.
endDate string in the form YYYY-MM-DD, only cards created before the specified date will be included.

Set Account Limits (Enterprise)

API reference: Set account spend limits

Set spend limits for a specified account. Can only be run on accounts that are part of the instance managed by this API key. Returns an AccountConfiguration object.

POST https://api.lithic.com/v1/account/limit

Sample Request

curl https://api.lithic.com/v1/account/limit \
  -X POST \
  -H "Authorization: api-key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account_token":"ecbd1d58-0299-48b3-84da-6ed7f5bf9ec1","daily_spend_limit":100000}'

Sample Response

{
  "data": [
    {
      "account_token": "ecbd1d58-0299-48b3-84da-6ed7f5bf9ec1",
      "state": "ACTIVE",
      "spend_limit": {
        "daily": 100000,
        "monthly": 400000,
        "lifetime": 1000000
      }
    }
  ],
  "page": 1,
  "total_entries": 1,
  "total_pages": 1
}
account_tokenGlobally unique identifier for the account.
daily_spend_limitAmount (in cents) for the account's new daily spend limit.
monthly_spend_limitAmount (in cents) for the account's new monthly spend limit.
lifetime_spend_limitAmount (in cents) for the account's new lifetime limit. Once this limit is reached, no transactions will be accepted on any card created for this account until the limit is updated.

Set Account State (Enterprise)

API reference: Set account state

Set the state for a specified account. Accounts that are in the PAUSED state will not be able to transact or create new cards. Can only be run on accounts that are part of the instance managed by this API key. Returns an AccountConfiguration object.

POST https://api.lithic.com/v1/account/state

Sample Request

curl https://api.lithic.com/v1/account/state \
  -X POST \
  -H "Authorization: api-key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"account_token":"b68b7424-aa69-4cbc-a946-30d90181b621","state":"ACTIVE"}'

Sample Response

{
  "data": [
    {
      "account_token": "b68b7424-aa69-4cbc-a946-30d90181b621",
      "state": "ACTIVE",
      "spend_limit": {
        "daily": 100000,
        "monthly": 400000,
        "lifetime": 1000000
      }
    }
  ],
  "page": 1,
  "total_entries": 1,
  "total_pages": 1
}
account_tokenGlobally unique identifier for the account.
stateACTIVE or PAUSED.

Did this page help you?