Sign in

v66

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

List rules

Lists V2 Auth rules

get/v2/auth_rules

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.

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": [
              "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
        }
      }
    }
  ]
}