Auth Rules

List rules

Changed on

Lists V2 Auth rules

get/v2/auth_rules

Request

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

Query parameters

ending_beforestring uuid

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_sizeinteger

Page size (for pagination).

starting_afterstring uuid

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

card_tokenstring uuid

Only return Auth Rules that are bound to the provided card token.

account_tokenstring uuid

Only return Auth Rules that are bound to the provided account token.

business_account_tokenstring uuid

Only return Auth Rules that are bound to the provided business account token.

scope'PROGRAM' | 'ACCOUNT' | 'BUSINESS_ACCOUNT' | 'CARD' | 'ANY'

Only return Auth Rules that are bound to the provided scope. When no token is provided, CARD also returns Auth Rules that include a CARD_TAG entity.

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

The event stream during which the rule will be evaluated.

Deprecated: Use event_streams instead. Only return Auth rules that are executed during the provided event stream.

event_streamsEventStream[]

Only return Auth rules that are executed during any of the provided event streams. If event_streams and event_stream are specified, the values will be combined.

Response

Auth Rules

has_moreboolean required

Indicates whether there are more Auth Rules to be retrieved by paging through the results.

Example response

{
  "data": [
    {
      "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

  • 9798275dc379Revision changes
    • warning

      added the new CARD_AGE enum value to the //////// response property for the response status

    • warning

      added the new CARD_AGE enum value to the //////// response property for the response status

    • warning

      added the new CARD_PROGRAM_FAMILY enum value to the //////// response property for the response status

    • warning

      added the new CARD_PROGRAM_FAMILY enum value to the //////// response property for the response status

    • warning

      added the new CARD_STATE enum value to the //////// response property for the response status

    • warning

      added the new CARD_STATE enum value to the //////// response property for the response status

    • warning

      added the new CARD_TYPE enum value to the //////// response property for the response status

    • warning

      added the new CARD_TYPE enum value to the //////// response property for the response status

    • warning

      added the new IS_DOMESTIC enum value to the //////// response property for the response status

    • warning

      added the new IS_DOMESTIC enum value to the //////// response property for the response status

    • warning

      added the new IS_DOMESTIC enum value to the //////// response property for the response status

    • warning

      added the new IS_DOMESTIC enum value to the //////// response property for the response status

    • warning

      added the new PIN_STATUS enum value to the //////// response property for the response status

    • warning

      added the new PIN_STATUS enum value to the //////// response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added subschema #1 subschema #2 to the /////// response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the /////// response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

    • info

      response property data/items/account_tokens deprecated

    • info

      response property data/items/business_account_tokens deprecated

    • info

      response property data/items/card_tokens deprecated

    • info

      response property data/items/excluded_account_tokens deprecated

    • info

      response property data/items/excluded_business_account_tokens deprecated

    • info

      response property data/items/excluded_card_tokens deprecated

    • info

      response property data/items/program_level deprecated

    • info

      removed the CONDITIONAL_BLOCK enum value from the // response property for the response status

    • info

      removed subschema #1 subschema #2 from the /////// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /////// response property oneOf list for the response status

    • info

      added the required property // to the response with the status

  • b61b531b055cRevision changes
    • warning

      added the new OTHER enum value to the // response property for the response status