Rules

What is it?

"Rules" is an automated routing of charges feature, which allows you to combine several parameters while creating a rule. This feature enables you to control charge processing based on parameters such as PAN (card number), payment source, amount, currency, card type, etc.

Let's take a look at each Rules section in more detail...


1) The Routing Section

How to create a new rule

The first rule created will be set as the default one. If no rule is applied, this will define the final gateway and the flow of payment. 

To add a rule, follow the below steps:

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and make sure you are in the Routing tab;
  3. Choose the Add New button;
  4. Add the Rule Label, which will allow you to define the rulemaking it easier for you to track! You can select the Rule Type by choosing from:
    • Currency;
    • Payment Source Type;
    • Card Scheme.

  5. Once this is completed, choose a Rule Operator from the ones described below:
    • Equals: choose one option, for which the rule will be applied;
    • Does not equal: choose the only option, for which the rule will not be applied;
    • In: choose several options, for which the rule will be applied;
    • Not in: choose several options, for which the rule will not be applied.
  6. Select the Payment Service you would like to route the payment to;
  7. Click on the Create Rule button to add the new Rule to the list.

The default status of the first created rule is Active. However, other rules that you create will need to be activated manually, as described below.

Note: Before setting up a new rule, please make sure that the payment service you select supports the indicated currency, payment source type or card scheme. These parameters should be checked on the payment service side.

How to activate rules

Below is a step-by-step guide on how to enable/disable a created rule.

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and make sure you are in the Routing tab;
  3. Click on the Actions button on the required Rule;
  4. Choose the Activate/Deactivate Rule option from the drop-down.


Note: This feature is not available for your default rule. However, you can edit any rule from the Actions button, even the default ones.

How to check the existing rules

We have a testing feature where you can check your rules before enabling them on your Paydock account. This allows you to check if the rule works as intended.

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and make sure you are in the Routing tab;
  3. Find the Check A Rule section at the bottom page;
  4. Choose Currency, Payment type, Amount and PAN (card number) for checking the rule;
  5. Click the Check Rule button; 
  6. Success! The rule result is displayed on the screen.

Priority setting of multiple rules

This feature allows you to change the prioritisation of the rules if there are more than 1.

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and make sure you are in the Routing tab;
  3. Drag the rule using the hamburger menu button to the desired position;
  4. Your rules will be processed according to the order.


2) The Reject Rules Section

With our reject rules feature, you are able to reject a charge before sending a request to the gateway.

How to create a new rule

To add a rule, follow these steps:

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and choose the Charge Reject tab;
  3. Choose the Add New button;
  4. Add the Rule Label, which will help you remember what this rule is for, and select the Rule Type by choosing from:
    • Currency;
    • Amount;
    • Card Scheme;
    • Payment Source Type;
    • PAN;
    • Address Country;
    • Custom Fields.

  5. Once this is completed, choose a Rule Operator from the list below: 
    • In: choose several options, from which the rule will be applied;
    • Not in: choose several options, from which the rule will not be applied;
    • Less than: if the indicated amount is greater than the charged amount, the charge itself will be rejected - for Amount only;
    • Less than or equal: if the indicated amount is equal or greater than the charged amount, the charge itself will be rejected - for Amount only;
    • Greater than: if the indicated amount is less than the charged amount, the charge itself will be rejected - for Amount only;
    • Greater than or equal: if the indicated amount is equal or less than the charged amount, the charge itself will be rejected - for Amount only.
  6. Indicate the Reason for Rejection, i.e. the message explaining why this charge will be rejected.
  7. Click on the Create Rule button to add the new rule to the list.

The default status of the created Rule is Inactive. Therefore, all the Rules will need to be activated manually, as described below.

How to activate rules

Below is a step-by-step guide on how to enable/disable a created rule.

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and go to the Charge Reject tab;
  3. Click on the Actions button near the needed Rule;
  4. Choose the Activate/Deactivate Rule option from the drop-down.

Note: The rule can also be edited using the Actions button.

How to check the existing rules

Here we have a testing feature similar to the one in ‘ Routing’ where you can check your rules before enabling them in your Paydock account. This allows you to check if the rule works as intended.

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left and go to the Charge Reject tab;
  3. Find the Check A Rule section on the bottom page;
  4. Choose Currency, Payment type, Amount, PAN (card number), Address country (optional) and Custom Fields (optional) to check the rule;
  5. Click the Check Rule button; 
  6. Success! The rule result is displayed on the screen.

Priority setting of multiple rules

This feature allows you to change the prioritisation of your rules if there are more than 1.

  1. Log into your Paydock Production or Sandbox account;
  2. Navigate to Rules from the menu on the left, then go to the Charge Reject tab;
  3. Drag the rule using the hamburger menu button to the desired position;
  4. Your rules will be processed according to the order.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us