Documentation
Request a demo
Start typing to search…

Create Firewall rule

After you installed the Firewall add-on, you can start creating Firewall rules. They are the core instruments that allows shaping the preconditions of the secure transactions finalisation.

Initiate creating a Rule

  1. Navigate to the Add-ons tab in the main sidebar menu.
  2. Click Firewall. The system redirects you to the respective page.
  3. You can also navigate to the particular entity (e.g. Provider entity), namely to its Firewall tab.
  4. Click Create Firewall rule. It initiates opening a sidebar window.
  5. To add a Name to a new Rule, enter the text into the corresponding text field.
  6. Then, specify the Triggers group and select the Triggers from the respective dropdown list.
📘

For your information!

Triggers group is the combination of Events that should trigger the Rule.

Triggers group Triggers
Transaction
  • Payment routing: triggers during Payment route filtering.
  • Payout routing: triggers during Payout route filtering.
Initiate
  • Payment creation: triggers when a new Payment Request is created.
  • Payout creation: triggers when a new Payout Request is created.
Commit
  • Payment attempt: triggers while processing a payment via API or Checkout.
  • Payout attempt: triggers while processing a payout via API.
Custom All user-defined events.
  1. After specifying Triggers, you can build Conditions. Identify an Action first.
📘

Be aware!

Action defines the way in which the Condition should be fulfilled and influences the final outcome.

Action Description
Block
  • The action blocks the transaction finalisation if the defined Rule is fulfilled.
  • The action blocks the transaction creation if the chosen Trigger group is Transaction and the Rule is fulfilled.
  1. To form a Condition, select the Attribute and Operator from the corresponding dropdown lists.
  2. Enter a Value into a respective text field.
  3. To add a Group or Property, click the corresponding buttons and select the logical operator AND/OR.
  • AND: Requires all Conditions to be true to get the specific result and allow the system to apply a Rule.
  • OR: Requires at least one Condition to be true to set up a Rule.
  1. Click Create Rule.

Firewall rules overview

Attribute → applied Description Precondition for the value entity
Card Failed Day/Month/Week The property covers the system response to the number of failed card payments fulfilled per day, week or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Card Fingerprint A unique identifier generated from the card details used to detect repeated or suspicious usage patterns. Data type: string.
Card First 6 The property covers the Card BIN, which is the first 6 items of a credit or debit card number used to identify which bank or institution issued the card. The Routing condition can be created based on that data. Data type: integer. The total number of characters in the string should be equal to 6.
Card Issuer Country The country where the card was issued, based on the Card BIN (Bank Identification Number). You can choose the value from the dropdown list containing the supported countries.
Card Issuer Phone The official contact phone number of the bank or institution that issued the card. Data type: string.
Card Issuer Website The official website of the card-issuing bank or institution. Data type: string.
Card Network The property covers the system response to the payment Card network type: Visa, Mastercard, American Express, Discover, Diners Club, China UnionPay, etc. You can choose the value from the dropdown list containing all supported Card networks.
Card Payments Day/Month/Week The property covers the system response to all card payments (successful and failed) fulfilled per day, week or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Card Successful Day/Month/Week The property covers the system response to the number of successful card payments fulfilled per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Card Turnover Day/Month/Week The property covers the system response to the total monetary value of all card transactions per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Client IP The IP address of the Customer making a Payment Commit, used to identify geographic or network-related risks. Data type: string.
Customer Email The email address associated with the Customer who made a Payment Commit. Data type: string. The total number of characters in the string should be less than 80.
Customer Failed Day/Month/Week The property covers the system response to the number of Customer's failed payments fulfilled per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer ID A unique internal identifier assigned to the Customer in the system. You can choose the value from the dropdown list or enter an ID manually.
Customer Name The name of the Customer who made a Payment Commit. Data type: string.
Customer Payments Day/Month/Week The property covers the system response to the number of all Customer's payments fulfilled per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Phone The phone number provided by the Customer, used for verification or risk evaluation. Data type: string.
Customer Successful Day/Month/Week The property covers the system response to the number of Customer's successful payments fulfilled per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Customer Turnover Day/Month/Week The property covers the system response to the total monetary value of all Customer’s transactions per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Merchant Account Failed Day/Month/Week The property covers the system response to the number of failed payments fulfilled within the scope of one Merchant account per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Merchant Account ID A unique internal identifier assigned to the Merchant account in the system. You can choose the value from the dropdown list or enter an ID manually.
Merchant Account Payments Day/Month/Week The property covers the system response to the total number of payments fulfilled within the scope of one Merchant account per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Merchant Account Successful Day/Month/Week The property covers the system response to the number of successful payments fulfilled within the scope of one Merchant account per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Merchant Account Turnover Day/Month/Week The property covers the system response to the total monetary value of all transactions fulfilled within the scope of one Merchant account per day, week, or month accordingly. Data type: float. The total number of characters in the string should be less than or equal to 15.
Payment Route ID A unique internal identifier assigned to the Payment Route in the system. You can choose the value from the dropdown list or enter an ID manually.
Provider Account ID A unique internal identifier assigned to the Provider account in the system. You can choose the value from the dropdown list or enter an ID manually.
Payment request amount The property covers the amount that was stated during the Payment Request. Data type: float. The total number of characters in the string should be less than or equal to 15.
Payment commit amount The property covers the amount stated when the Payment Commit was made. Data type: float. The total number of characters in the string should be less than or equal to 15.
Payment request currency The property corresponds to a currency used when creating a Payment Request. You can choose the value from the dropdown list containing the overview of all supported currencies.
Payment Request Metadata The property covers the Metadata included in the Payment Request. You can enter data into the input key and input value fields. The key is an attribute, and the value is the key parameter. Data type: text, integer, float.

Condition attributes & Operators matrix

Operators →
Conditions ↓		 = Equals to ≠ Not equals > Greater than ≥ Greater or equal < Less than ≤ Less or equal =+ Equals any of ≠+ Not equals any of = Matches → On a List −→ Not on a List = Key exists = Key not exist = Key matches
Card Failed Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Fingerprint ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card First 6 ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card Issuer Country ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card Issuer Phone ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card Issuer Website ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Card Network ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Card Payments Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Successful Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Card Turnover Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Client IP ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Customer Email ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Customer Failed Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer ID ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Customer Name ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Customer Payments Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Phone ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Customer Successful Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Customer Turnover Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Merchant Account Failed Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Merchant Account ID ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌
Merchant Account Payments Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Merchant Account Successful Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Merchant Account Turnover Day/Month/Week ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Payment Route ID ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Provider Account ID ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌
Payment request amount ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Payment commit amount ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌
Payment request currency ✅ ✅ ❌ ❌ ❌ ❌ ✅ ✅ ❌ ✅ ✅ ❌ ❌ ❌
Payment Request Metadata ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅ ✅

*To learn more about each operator, go to theApply Routing rules guide.

Updated 3 months ago