Auth Rules

Update rule entities

Changed on

Adds entities to and removes entities from a V2 Auth rule's include and exclude lists

To replace all of the rule's entities at once, provide entities to PATCH /v2/auth_rules/{auth_rule_token} instead.

patch/v2/auth_rules/{auth_rule_token}/entities

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v2/auth_rules/{auth_rule_token}/entities
  • Auth
    API key in header Authorization

Path parameters

auth_rule_tokenstring uuid required

Request body

Response

Auth Rule

tokenstring uuid required

Auth Rule Token

state'ACTIVE' | 'INACTIVE' required

The state of the Auth Rule

program_levelboolean required

Deprecated: Use entities.include with a PROGRAM entity instead.

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

card_tokensstring[] required

Deprecated: Use entities.include with CARD entities instead.

Card tokens to which the Auth Rule applies. Cards the rule applies to through a CARD_TAG entity are not listed.

excluded_card_tokensstring[]

Deprecated: Use entities.exclude with CARD entities instead.

Card tokens to which the Auth Rule does not apply. Cards excluded through a CARD_TAG entity are not listed.

excluded_account_tokensstring[]

Deprecated: Use entities.exclude with ACCOUNT entities instead.

Account tokens to which the Auth Rule does not apply.

excluded_business_account_tokensstring[]

Deprecated: Use entities.exclude with BUSINESS_ACCOUNT entities instead.

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

account_tokensstring[] required

Deprecated: Use entities.include with ACCOUNT entities instead.

Account tokens to which the Auth Rule applies.

business_account_tokensstring[] required

Deprecated: Use entities.include with BUSINESS_ACCOUNT entities instead.

Business Account tokens to which the Auth Rule applies.

type'VELOCITY_LIMIT' | 'MERCHANT_LOCK' | 'CONDITIONAL_ACTION' | 'TYPESCRIPT_CODE' | 'OTHER' 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.

  • 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.
  • OTHER: A rule whose type is not exposed through this API. Rules of this type are read-only; OTHER cannot be used when creating a rule.
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": [
          "USA"
        ],
        "exclude_countries": [
          "USA"
        ]
      },
      "limit_amount": 10000,
      "limit_cash_amount": 5000
    }
  },
  "draft_version": {
    "parameters": {
      "filters": {
        "include_mccs": [
          "5542"
        ],
        "exclude_mccs": [
          "5542"
        ],
        "include_countries": [
          "USA"
        ],
        "exclude_countries": [
          "USA"
        ]
      },
      "limit_amount": 10000,
      "limit_cash_amount": 5000
    }
  }
}

Changes