Search

Are you looking for test card numbers?

Would you like to contact support?

Issuin icon

Transaction rules reference

Understand the values that you can use for rule types, conditions, and interval types.

Rule types

The following are possible values that you can use when specifying the rule type:

Rule type Description
allowList The rule provides a list of categories where transactions must always be allowed.
blockList The rule provides a list of categories where transactions must always be blocked.
maxUsage The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument.
velocity The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.

Conditions

You can use the following conditions in your transaction rule:

Condition Description
amount The maximum amount that a payment instrument can be used for in a given period specified in the interval.type. If the transaction is in a different currency, the currency is converted before the rule is evaluated.
maxTransactions The maximum number of transactions that a payment instrument can be used for in a given period specified in the interval.type.
countries List of countries to which the rule applies.
mccs List of merchant category codes (MCCs) to which the rule applies.
entryModes List of point-of-sale entry modes to which the rule applies.
Possible values: manual, chip, magstripe, contactless, cof, token, server, barcode, ocr.
processingTypes List of processing types to which the rule applies.
Possible values: atmWithdraw,pos, ecommerce, moto, recurring

Rule validity

Aside from conditions that you can derive from a payment's properties, you can also include set dates for the rule validity.

Condition Description
startDate Date and time, in ISO 8601 extended offset date-time format. For example, 2020-12-18T10:15:30+01:00. If the rule is created with status Active and no startDate is provided, the time of creation is used and the rule is applied immediately.
endDate Date and time in ISO 8601 extended offset date-time format. For example, 2021-01-16T10:15:30+01:00. If no endDate is provided, the rule is applied indefinitely.

Interval types

The following are possible values that you can use to set the the time interval in the interval.type:

Interval type How a rule is applied
perTransaction Rule is applied for each transaction.
daily Counters are reset every day at UTC 00:00:00.
weekly Counters are reset every Monday at UTC 00:00:00.
monthly Counters are reset every 1st day of the month at UTC 00:00:00.
lifetime The conditions and limits apply to the lifetime of the payment instrument.

In a future version of the API, we'll expand the interval configuration to support setting the timezone, day of week or month, counter reset time, and custom time intervals.

Possible combinations

You can create rules with the following combinations.

Rule type Conditions Interval type
allowList countries, mccs, processingTypes, entryModes,
startDate, endDate
perTransaction
blockList countries, mccs, processingTypes, entryModes,
startDate, endDate
perTransaction
maxUsage amount, maxTransactions,
startDate, endDate
lifetime
velocity amount, maxTransactions, countries, mccs, processingTypes, entryModes
startDate, endDate
daily, weekly, monthly,
perTransaction