Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
Auth Rules

Draft a new rule version

Creates a new draft version of a rule that will be ran in shadow mode.

This can also be utilized to reset the draft parameters, causing a draft version to no longer be ran in shadow mode.

post/v2/auth_rules/{auth_rule_token}/draft

Path parameters

auth_rule_tokenstring uuid required

Request body

Example request

{
  "parameters": {
    "filters": {
      "include_mccs": [
        "5542"
      ],
      "exclude_mccs": [
        "5542"
      ],
      "include_countries": [
        "USD"
      ],
      "exclude_countries": [
        "USD"
      ]
    },
    "limit_amount": 10000
  }
}

Response

Auth Rule

tokenstring uuid required

Auth Rule Token

state'ACTIVE' | 'INACTIVE' required

The state of the Auth Rule

program_levelboolean required

Whether the Auth Rule applies to all authorizations on the card program.

card_tokensstring[] required

Card tokens to which the Auth Rule applies.

excluded_card_tokensstring[]

Card tokens to which the Auth Rule does not apply.

excluded_account_tokensstring[]

Account tokens to which the Auth Rule does not apply.

excluded_business_account_tokensstring[]

Business account tokens to which the Auth Rule does not apply.

account_tokensstring[] required

Account tokens to which the Auth Rule applies.

business_account_tokensstring[] required

Business Account tokens to which the Auth Rule applies.

type'CONDITIONAL_BLOCK' | 'VELOCITY_LIMIT' | 'MERCHANT_LOCK' | 'CONDITIONAL_ACTION' | 'TYPESCRIPT_CODE' required

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate event_stream field.

  • CONDITIONAL_BLOCK: Deprecated. Use CONDITIONAL_ACTION instead. AUTHORIZATION event stream.
  • VELOCITY_LIMIT: AUTHORIZATION event stream.
  • MERCHANT_LOCK: AUTHORIZATION event stream.
  • CONDITIONAL_ACTION: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or ACH_PAYMENT_UPDATE event stream.
  • TYPESCRIPT_CODE: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or ACH_PAYMENT_UPDATE event stream.
namestring nullable required

Auth Rule Name

event_stream'AUTHORIZATION' | 'THREE_DS_AUTHENTICATION' | 'TOKENIZATION' | 'ACH_CREDIT_RECEIPT' | 'ACH_DEBIT_RECEIPT' | 'CARD_TRANSACTION_UPDATE' | 'ACH_PAYMENT_UPDATE' required

The event stream during which the rule will be evaluated.

lithic_managedboolean required

Indicates whether this auth rule is managed by Lithic. If true, the rule cannot be modified or deleted by the user

Example response

{
  "current_version": {
    "parameters": {
      "filters": {
        "include_mccs": [
          "5542"
        ],
        "exclude_mccs": [
          "5542"
        ],
        "include_countries": [
          "USD"
        ],
        "exclude_countries": [
          "USD"
        ]
      },
      "limit_amount": 10000
    }
  },
  "draft_version": {
    "parameters": {
      "filters": {
        "include_mccs": [
          "5542"
        ],
        "exclude_mccs": [
          "5542"
        ],
        "include_countries": [
          "USD"
        ],
        "exclude_countries": [
          "USD"
        ]
      },
      "limit_amount": 10000
    }
  }
}