Description

Rules can be applied to either Filters or Routes and allow your organization make decisions about what to do with a transaction based on either the currently information being processed or the history of the customer processing the transaction. Each Rule also has a Condition setting, which you can learn about here: How Rule Conditions Work.

 

Rules

---

Currency

Represents the Currency the current transaction is being transacted in. This value is sent by your CRM, Point of Sale or Ecommerce Engine.

VALUES 3 character ISO 4217 country code

EXAMPLES USD, AUD, GBP

SOURCE Incoming Transaction

REFERENCE Currency Codes

 

 

---

Device Type

Represents the type of device this transaction originated from.

VALUES Unknown, Unattended Terminal, Self Service Terminal, Electronic Cash Register, Personal Computer Based Terminal, Wireless POS, Website, Dial Terminal, Virtual Terminal

SOURCE Current Transaction

 

 

---

Employee Number

The merchant assigned Employee ID. Required for payment processor EVO.

VALUES Thirty-two (32) characters unless using EVO in which case it is Four (4) digits

SOURCE Incoming Transaction

 

 

---

Invoice Number

The order id associated with the transaction involving the sale between merchant and customer.
Identifier is assigned by the merchant. If not provided, this will default to the transaction id assigned by
your gateway.

VALUES Sixty-four (64) characters corresponding to assigned transaction id

SOURCE Incoming Transaction - orderid

 

---

Transaction IP Address

The IP address related to the cardholder that is making the order.
This field is strongly recommended to include.

VALUES Format: [0-255].[0-255].[0-255]

EXAMPLES 255.255.255.255

SOURCE Incoming Transaction - ipaddress

 

---

Purchase order number

supplied by the cardholder.

VALUES Sixteen (16) characters

EXAMPLES PO-02012

SOURCE Incoming Transaction - ponumber

 

---

Total

Total amount to be involved in transaction.
For validate, the amount MUST be omitted or set to 0.00.

VALUES A decimal dollar amount with precision up to cents. Format: x.xx

EXAMPLES 1055.69

SOURCE Incoming Transaction - amount

 

---

Transaction Type

The type of transaction to be processed.

VALUES sale, auth, capture, credit, refund, void, validate, offline

SOURCE Incoming Transaction - type

 

---

Account Number

The customer's masked bank account number located on the check.

EXAMPLES 6XXXXX0987

SOURCE Incoming Transaction - checkaccount

 

---

Account Routing Number

The customer's masked routing number located on the check.

EXAMPLES 091000019

SOURCE Incoming Transaction - checkaba

 

---

Credit Card Number

The customer's credit card number.

EXAMPLES 411111XXXXXX11111

SOURCE Incoming Transaction - ccnumber

 

---

Credit Card CVV

The customer's credit card's cvv.

VALUES Three (3) or four (4) characters

EXAMPLES 111

SOURCE Incoming Transaction - cvv

 

---

Address

The customer's address associated with either customer's billing or shipping, accounts, or credit cards.

EXAMPLES 11 Notreal Lane

SOURCE Incoming Transaction - shipping_address1, address1

 

---

City/Locality

The customer's city associated with either customer's billing or shipping, accounts, or credit cards.

EXAMPLES New York City

SOURCE Incoming Transaction - shipping_city, city

 

---

Provence/State

The customer's state associated with either billing or shipping, accounts, or credit cards.

VALUES FORMAT: CC

EXAMPLES NY

SOURCE Incoming Transaction - shipping_state, state

 

---

Postal/Zip Code

The customer's postal code associated with either billing or shipping, accounts, or credit cards.

EXAMPLES 45211

SOURCE Incoming Transaction - shipping_zip, zip

 

---

Country

The customer's country associated with either billing or shipping, accounts, or credit cards. Country codes are as shown in ISO 3166.

VALUES ISO 3166 Format: CC

EXAMPLES US

SOURCE Incoming Transaction - shipping_country, country

 

---

Customer Address

The customer's address associated with either billing or shipping.

EXAMPLES 11 Notreal Lane

SOURCE Incoming Transaction - shipping_address1, address1

 

---

Customer City/Locallity

The customer's city associated with either customer's billing or shipping.

EXAMPLES New York City

SOURCE Incoming Transaction - shipping_city, city

 

---

Customer Provence/State

The customer's state associated with either billing or shipping.

VALUES FORMAT: CC

EXAMPLES NY

SOURCE Incoming Transaction - shipping_state, state

 

---

Customer Postal/Zip Code

The customer's postal code associated with either billing or shipping.

EXAMPLES 45211

SOURCE Incoming Transaction - shipping_zip, zip

 

---

Customer Country

The customer's country associated with either billing or shipping. Country codes are as shown in ISO 3166.

VALUES ISO 3166 Format: CC

EXAMPLES US

SOURCE Incoming Transaction - shipping_country, country

 

---

Payment Address

The customer's address associated with billing.

EXAMPLES 11 Notreal Lane

SOURCE Incoming Transaction - address1

 

---

Payment City/Locallity

The customer's city associated with billing.

EXAMPLES New York City

SOURCE Incoming Transaction - city

 

---

Payment Provence/State

The customer's state associated with either billing.

VALUES FORMAT: CC

EXAMPLES NY

SOURCE Incoming Transaction - state

 

---

Payment Postal/Zip Code

The customer's postal code associated with billing.

EXAMPLES 45211

SOURCE Incoming Transaction - zip

 

---

Payment Country

The customer's country associated with billing. Country codes are as shown in ISO 3166.

VALUES ISO 3166 Format: CC

EXAMPLES US

SOURCE Incoming Transaction - country

 

---

Phone

The customer's phone number associated with their billing information.

EXAMPLES 9496006666

SOURCE Incoming Transaction - phone

 

---

Customer Phone

The customer's phone number associated with their credit card billing information.

EXAMPLES 9496006666

SOURCE Incoming Transaction - phone

 

---

Payment Phone

The customer's phone number associated with their checking or address information

EXAMPLES 9496006666

SOURCE Incoming Transaction - phone

 

---

Company Name

The name of the card holder's company.

EXAMPLES OpenPath, Inc.

SOURCE Incoming Transaction - company

 

---

Customer Name

The full name of the cardholder, including their first and last names.

EXAMPLES Keenan Yost

SOURCE Incoming Transaction - first_name, last_name

 

---

Email Address

The e-mail address associated with the cardholder's billing or shipping information.

EXAMPLES john.doe@emaildomain.com

SOURCE Incoming Transaction - email, shipping_email

 

---

Attributes

Any attribute associated with the incoming transaction coming from the customer. This could be their first_name, last_name, amount etc.

VALUES A key-value pair using the attribute's name to its value. Format: {field:[atttributeName]=[value]}

EXAMPLES {field:merchant_defined_field_1=food}

SOURCE Incoming Transaction - any transaction request attribute

 

---

Continent

The continent that corresponds to the country in which the customer's billing address resides.

VALUES Africa, Antarctica, Asia, Europe, NorthAmerica, SouthAmerica, Australia

SOURCE Incoming Transaction - country

 

---

Account Name

The name on the customer's ACH account.

EXAMPLES Restaurant Inc

SOURCE Incoming Transaction - checkname

 

---

 

First Name

The first name of the customer.

EXAMPLES Keenan

SOURCE Incoming Transaction - first_name. Legacy variables include: firstname

 

---

Last Name

The last name of the customer.

EXAMPLES Yost

SOURCE Incoming Transaction - last_name. Legacy variables include: lastname

 

---

 

Item Description

A description for one of the line items ordered by the customer.

EXAMPLES Blue Aviators

SOURCE Incoming Transaction - item_description_# where # is a number

 

---

Item SKU

A SKU for one of the line items ordered by the customer.

EXAMPLES FM-987

SOURCE Incoming Transaction - item_product_code_# where # is a number

 

---

Item Commodity

A commodity code for one of the line items ordered by the customer.

EXAMPLES 44120000

SOURCE Incoming Transaction - item_commodity_code_# where # is a number

 

---

Item Unit Type

A code for units of measurement as used in international trade applicable to one of the line items ordered by the customer.

VALUES Default: 'EACH'

EXAMPLES EACH

SOURCE Incoming Transaction - item_unit_of_measure_# where # is a number

 

---

Item Quantity

A quantity for one of the line items ordered by the customer.

EXAMPLES 3

SOURCE Incoming Transaction - item_quantity_# where # is a number

 

---

Item Total

The total amount that one of the line items ordered by the customer costed.

VALUES A decimal dollar amount with precision up to cents. Format: x.xx

EXAMPLES 300.00

SOURCE Incoming Transaction - item_total_amount_# where # is a number

 

---

Item Tax

A tax corresponding to one of the line items ordered by the customer.

VALUES A decimal dollar amount with precision up to cents. Format: x.xx

EXAMPLES 0.50

SOURCE Incoming Transaction - item_tax_amount_# where # is a number

 

---

Item Duty

An amount included in the transaction amount associated with the import of the order.

VALUES A decimal dollar amount with precision up to cents. Format: x.xx

EXAMPLES 0.50

SOURCE Incoming Transaction - duty_amount

 

---

Item External ID

A merchant defined description code of the line item purchased by the customer.

EXAMPLES TEA-01

SOURCE Incoming Transaction - item_product_code_# where # is a number

 

---

City, Provence/State

The city along with the provence of the customer's billing or shipping address, combined.

VALUES Format: [City], [Provence]

EXAMPLES Manhattan, NY

SOURCE Incoming Transaction - shipping_city + shipping_state, city + state

 

---

 

IP Address World Major Region

The major region in which the customer's IP address exists.

VALUES North America, Unknown

SOURCE Incoming Transaction - ipaddress

 

---

IP Address World Minor Region

The minor region in which the customer's IP address exists.

VALUES Northen America, Unknown

SOURCE Incoming Transaction - ipaddress

 

---

Visa Mastercard World Major Region

The major region of the country associated with the customer's billing address.

VALUES North America, Unknown

SOURCE Incoming Transaction - country

 

---

Visa Mastercard World Minor Region

The minor region of the country associated with the customer's billing address.

VALUES Northern America, Unknown

SOURCE Incoming Transaction - country

 

---

Credit Card Country

The country code of the country from which the customer's credit card is issued. The country code corresponds to ISO 3166.

VALUES ISO 3166 Format: CC

EXAMPLES US, FR, DE

SOURCE Incoming Transaction - ccnumber

 

---

Transaction Result Value

The Transaction Result Value rule compares against the value of the Result with type "Transaction" that occurs when the transaction is processed by OpenPath. Typically, the rule is applied to a cascaded transaction that needs to be reprocessed.

EXAMPLES 100 | SUCCESS

SOURCE Internal

 

---

Credit Card Brand

The brand of the credit card used.

EXAMPLES Mastercard, Visa

SOURCE Incoming Transaction - ccnumber

 

---

Customer Address and Postal Code

The customer's billing or shipping street address and postal code, combined.

VALUES Format: [CustomerAddress], [PostalCode]

EXAMPLES 11 Notreal Lane, Los Angeles

SOURCE Incoming Transaction - address1 + zip, shipping_address1 + shipping_zip

 

---

Payment Address and Postal Code

The customer's billing street address and postal code, combined.

VALUES Format: [CustomerAddress], [PostalCode]

EXAMPLES 11 Notreal Lane, Los Angeles

SOURCE Incoming Transaction - address1 + zip

 

---

Address and Postal Code

The customer's street address and postal code combined that are associated with either customer's billing or shipping, accounts, or credit cards.

VALUES Format: [CustomerAddress], [PostalCode]

EXAMPLES 11 Notreal Lane, Los Angeles

SOURCE Incoming Transaction - address1 + zip, shipping_address1 + shipping_zip

 

---

 

 

 

Bank

The issuing bank organization for the customer's credit card.

VALUES Sixty-four (64) characters naming the bank organization

EXAMPLES American Express Company

SOURCE Incoming Transaction - ccnumber

 

---

Payment Type

The type describing the customer's payment option.

VALUES [Brand of Credit Card] like Mastercard
Credit Card, Check, Card, Ach, Apple Pay, PayPal, Amazon Pay, Reach, Google Pay,
BitCoin, Ethereum, Litecoin, GiftCard, Paay

EXAMPLES Discover

SOURCE Internal

 

---

Credit Card Type

The customer's payment card type

VALUES Debit, Credit

SOURCE Internal

 

---

Time Zone

The customer's time zone according to their billing or shipping address.

VALUES 4 - Atlantic, 5 - Eastern, 6 - Central, 7 - Mountain, 8 - Pacific, 9 - Alaska, 10 - Hawaii-Aleutian Islands, 11 - Samoa

EXAMPLES 8

SOURCE Internal

 

---

Asian Percentage

The estimated percentage of the total population in the customer's zip code that is Asian.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Black Percentage

The estimated percentage of the total population in the customer's zip code that is Black.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Hawaiian Percentage

The estimated percentage of the total population in the customer's zip code that is Hawaiian.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Indian Percentage

The estimated percentage of the total population in the customer's zip code that is Indian.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Hispanic Percentage

The estimated percentage of the total population in the customer's zip code that is Hispanic.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

White Percentage

The estimated percentage of the total population in the customer's zip code that is White.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Other Percentage

The estimated percentage of the total population in the customer's zip code that is Other.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Male Percentage

The estimated percentage of the total population in the customer's zip code that is Male.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Female Percentage

The estimated percentage of the total population in the customer's zip code that is Female.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Median Age

The estimated median age of the total population in the customer's zip code.

VALUES A decimal number. Format: x.xx

EXAMPLES 40.00

SOURCE Internal

 

---

Median Male Age

The estimated median male age of the total population in the customer's zip code.

VALUES A decimal number. Format: x.xx

EXAMPLES 40.00

SOURCE Internal

 

---

Median Female Age

The estimated median female age of the total population in the customer's zip code.

VALUES A decimal number. Format: x.xx

EXAMPLES 40.00

SOURCE Internal

 

---

Household Income

The estimated average household income in the customer's zip code.

VALUES A decimal dollar amount with precision up to cents. Format: x.xx

EXAMPLES 1055.69

SOURCE Internal

 

---

Population

The total population in the customer's zip code.

EXAMPLES 50123

SOURCE Internal

 

---

Persons Per Household

The estimated average persons per household in the customer's zip code.

VALUES A decimal number. Format: x.xx

EXAMPLES 2.21

SOURCE Internal

 

---

City Type

The classification type of the customer's zip code.

VALUES M - APO/FPO Military, P - PO Box, U - Unique

EXAMPLES U

SOURCE Internal

 

---

Declined Count

The number of sales and capture transactions enacted against the customer that declined.

EXAMPLES 5

SOURCE Internal

 

---

Declined Percentage

The percentage of the customer's total transactions that are counted as declined.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Declined Amount

The sum of the prices for all declined transactions against the customer.

VALUES A decimal number up to the nearest cent. Format: x.xx

EXAMPLES 1059.99

SOURCE Internal

 

---

Refund Count

The number of approved transactions that were refunded or voided for the customer.

EXAMPLES 10

SOURCE Internal

 

---

Refund Percentage

The percentage of the customer's total transactions that are counted as refunded.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Refund Amount

The sum of the prices for all the customer's refunded transactions.

VALUES A decimal number up to the nearest cent. Format: x.xx

EXAMPLES 1059.99

SOURCE Internal

 

---

Chargeback Count

The number of transactions for the customer that were approved, but then had a chargeback.

EXAMPLES 5

SOURCE Internal

 

---

Chargeback Percentage

The percentage of the customer's total transactions that are counted as chargebacks.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Chargeback Amount

The sum of the prices for all the customer's chargeback transactions.

VALUES A decimal number up to the nearest cent. Format: x.xx

EXAMPLES 1059.99

SOURCE Internal

 

---

Approved Count

The number of sales and capture transactions executed for the customer that were approved.

EXAMPLES 5

SOURCE Internal

 

---

Approved Percentage

The percentage of the customer's total sales and capture transactions that were approved.

VALUES A decimal number between 0.00 and 1. Format: x.xx

EXAMPLES 0.56

SOURCE Internal

 

---

Approved Amount

The sum of the prices for all approved sales and capture transactions for the customer.

VALUES A decimal number up to the nearest cent. Format: x.xx

EXAMPLES 1059.99

SOURCE Internal

 

---

No Address Match & Total

No Address Match means that the customer's shipping address and billing address do not match. If these two addresses do not match, then the transaction's total amount is checked.

VALUES A dollar decimal amount, up to the nearest cent. Format: x.xx

EXAMPLES 1299.99

SOURCE Incoming Transaction - amount

---

Payment Type Count

The number of credit cards and bank accounts associated with the customer.

EXAMPLES 4

SOURCE Internal

 

---

Addresses Match

If the order's address should match the address expected for billing.

VALUES True, False

SOURCE Internal

 

Popular Fraud Rules

---

Velocity

The velocity rule looks at the timespan between a customer’s last two transactions regardless of the payment method(s) they are using or even if the payment types are the same or different. It also does not matter if the transaction was approved, declined, or errored, it will still be counted as a transaction.
For example, if a customer tries two transactions, one at 11:30 and one at 11:31 the velocity will return 1 Minute.

To enable this rule, you select the Velocity Rule and set it to (most likely Less Than) and then the timespan value.

 

 

VALUES Timespan

EXAMPLE 30 Seconds

SOURCES

• Current customer transaction
• Last transaction from incoming customer.

 

---

Fraudulent Card by IP Velocity

If a card has been determined by Visa, MasterCard, American Express or any supported network as fraudulent, stolen, lost or unacceptable in the past from the clients requesting IP address, then all future requests will be based on this criteria and the timespan of this criteria will be followed.

The timespan is based off of the last transaction that received this response from one of the supported networks.

 

 

VALUES [Timespan]

EXAMPLE 30 Seconds

SOURCES

• The current incoming IP Address.
• The last incoming transaction from this IP Address.

 

---

Velocity Rate

The Velocity Rate is based on how many transactions are allowed by a single customer in a given timespan. So if you wanted to limit a customer to no more than 3 purchases in a single day, you would set the condition to Is Less Than and the value to 3, 1 Day.

 

 

VALUES [Transaction Count], [Timespan]

EXAMPLE 25, 30 Days

SOURCES

• The current transaction
• The count of previous transactions

 

---

No Address Match & Velocity

No Address Match means that the customers Shipping Address and Billing Address do not match. If these two addresses do not match and the velocity timespan is reached then this rule will be matched.

 

 

VALUES [Timespan]

EXAMPLE 1 Hour

SOURCES

• Current transactions Shipping Address and Billing Address
• Previous transactions transaction from the same customer

 

---

Fraudulent Card by IP Velocity

The Fraudulent Card by IP Velocity rule looks at the timespan between now and the last declined sale, authorized, or capture transactions coming from the customer's IP address.
For example, if a customer tries two transactions, one at 11:30 and one at 11:31 the velocity will return 1 Minute.

VALUES Timespan

EXAMPLES 30 seconds

SOURCE Incoming Transaction - ipaddress

 

---

IP to Shipping Distance

The distance between the customer's IP address and their billing or shipping address in kilometers.

VALUES Decimal

EXAMPLES 488.53

SOURCE Incoming Transaction - ipaddress + zip, ipaddress + shipping_zip

 

---

IP Velocity

The IP Velocity rule looks at the timespan between now and the last transaction coming from the transaction's IP address.
For example, if there exists two transactions, one at 11:30 and one at 11:31 the velocity will return 1 Minute.

VALUES Timespan

EXAMPLES 30 seconds

SOURCE Incoming Transaction - ipaddress

 

---

IP to Billing Distance

The distance between the customer's IP address and their billing in kilometers.

VALUES Decimal

EXAMPLES 488.53

SOURCE Incoming Transaction - ipaddress + zip

 

---

IP to Billing then Shipping Distance

The distance between the customer's IP address and their billing address, or else their shipping address, in kilometers.

VALUES Decimal

EXAMPLES 488.53

SOURCE Incoming Transaction - ipaddress + zip, ipaddress + shipping_zip

 

---

Transaction Velocity Rate

This rule is based on how many transactions are allowed by a single site in a given timespan.
So if you wanted to limit a site to no more than 3 purchases in a single day, you would set the condition to Is Less Than and the value to 3, 1 Day.

VALUES [Transaction Count], [Timespan]

EXAMPLE 5, 7 Days

SOURCES

The Transactions previously seen in the last [Timespan]

 

---

Source IP Address

The IP address that is issuing the transaction request to our API.

VALUES Format: http://xxx.xxx.xxx.xxx

EXAMPLES 255.255.255.255

SOURCE HTTP Request

 

---

County/Region

The customer's county associated with their zip code related to billing or shipping.

EXAMPLES Honolulu

SOURCE Internal - based on billing or shipping postal code

 

---

Customer County/Region

The customer's county associated with their zip code related to billing or shipping.

EXAMPLES Honolulu

SOURCE Internal - based on billing or shipping postal code

 

---

Payment County/Region

The customer's county associated with their zip code related to billing.

EXAMPLES Honolulu

SOURCE Internal - based on billing postal code

 

 

 

Timespans

---

The timespan value is a smart box and understands the following examples:

• For 1 Minute the valid values are:
  • 1m
  • 1min
  • 1 Min
  • 1 Minute
• For 1 Hour and 10 Minutes the valid values are:
  • 1h, 10m
  • 1 Hour and 10 Minutes
  • 1 Hour, 10 Minutes
  • The above examples work for Days (d, day, days), Hours (h, hour, hours), Minutes (m, min, minute, minutes) and Seconds (s, sec, second, seconds).
• For 3 Days, 6 Hours and 30 Minutes the valid values are:
  • 3d, 6h, 30m
  • 3 Days, 6 Hours and 30 Minutes
  • 3 Days, 6 Hours, 30 Minutes

The above examples work for Days (d, day, days), Hours (h, hour, hours), Minutes (m, min, minute, minutes) and Seconds (s, sec, second, seconds).