Auth Rule

Auth Rule Token

Required Parameters

• token: Auth Rule Token (UUID)
• state: The state of the Auth Rule (enum)
  • ACTIVE
  • INACTIVE
• program_level: Whether the Auth Rule applies to all authorizations on the card program (boolean)
• card_tokens: Card tokens to which the Auth Rule applies (array of UUIDs)
• excluded_card_tokens: Card tokens to which the Auth Rule does not apply (array of UUIDs)
• excluded_account_tokens: Account tokens to which the Auth Rule does not apply (array of UUIDs)
• excluded_business_account_tokens: Business account tokens to which the Auth Rule does not apply (array of UUIDs)
• account_tokens: Account tokens to which the Auth Rule applies (array of UUIDs)
• business_account_tokens: Business Account tokens to which the Auth Rule applies (array of UUIDs)
• type: The type of Auth Rule (string, enum)
  • CONDITIONAL_BLOCK
  • VELOCITY_LIMIT
  • MERCHANT_LOCK
  • CONDITIONAL_ACTION
  • TYPESCRIPT_CODE
• current_version: Current version of the Auth Rule (null | object)
• draft_version: Draft version of the Auth Rule (null | object)
• name: Auth Rule Name (string)
• event_stream: The event stream during which the rule will be evaluated (string, enum)
  • AUTHORIZATION
  • THREE_DS_AUTHENTICATION
  • TOKENIZATION
  • ACH_CREDIT_RECEIPT
  • ACH_DEBIT_RECEIPT
  • CARD_TRANSACTION_UPDATE
  • ACH_PAYMENT_UPDATE
• lithic_managed: Indicates whether this auth rule is managed by Lithic (boolean)

Example Request

curl --request POST \
     --url https://sandbox.lithic.com/v2/auth_rules/auth_rule_token/draft \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "parameters": {\n    "conditions": [\n      {\n        "attribute": "MCC",\n        "operation": "IS_ONE_OF",\n        "value": "string"\n      }\n    ]\n  }\n}'

Example Response

{  
  "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
  "state": "ACTIVE",  
  "program_level": true,  
  "card_tokens": [\n    "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  ],  
  "excluded_card_tokens": [\n    "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  ],  
  "excluded_account_tokens": [\n    "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  ],  
  "excluded_business_account_tokens": [\n    "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  ],  
  "account_tokens": [\n    "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  ],  
  "business_account_tokens": [\n    "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  ],  
  "type": "CONDITIONAL_BLOCK",  
  "current_version": {  
    "parameters": {  
      "conditions": [  
        {  
          "attribute": "MCC",  
          "operation": "IS_ONE_OF",  
          "value": "string"  
        }  
      ]  
    },  
    "version": 0  
  },  
  "draft_version": {  
    "parameters": {  
      "conditions": [  
        {  
          "attribute": "MCC",  
          "operation": "IS_ONE_OF",  
          "value": "string"  
        }  
      ]  
    },  
    "version": 0,  
    "state": "PENDING",  
    "error": "string"  
  },  
  "name": "string",  
  "event_stream": "AUTHORIZATION",  
  "lithic_managed": true  
}