The Rule Manager allows you to create your own customised Rules (or activate/deactivate pre-defined system rules) on your site references.
For example:
- Send email notifications to you and your customers.
- Submitting a notification to your system when a transaction has been processed on your site.
- Cancelling or suspending a transaction based on the outcome of certain checks performed.
Required user roles
Admin, Developer
How to access
Rules are configured separately for each site reference you have access to.
Select your site from the “Sites” page and click the “Rule Manager” icon.
Process overview
When configuring Rules on your account, you will first need to understand Conditions and Actions:
A Condition defines the circumstances under which an Action will be performed.
(e.g. The Condition could be: for all successful Visa authorisations)
Trust Payments will perform an Action when all criteria of a Condition have been met.
(e.g. The Action could be: send the customer a receipt email)
Conditions and Actions are joined together to establish a Rule.
(e.g. The Rule could be: for all successful Visa authorisations, send the customer a receipt email)
Creating a Rule
To create a Rule, you must first create a Condition and an Action. Expand the drop-downs below to learn how.
If you already have a Condition and/or Action configured, you can skip ahead to the Create Rule section.
-
Navigate to the Rule Manager, select the relevant Action type from the drop-down box and click “Go”.
Learn about the different Action types
-
Click “Add new condition”.
-
Type a unique and descriptive name into the “Condition name” text field (e.g. "successful Visa AUTH").
-
Use the checkboxes to specify the terms under which the Action is triggered. Be aware of the drop-down boxes found above each group of checkboxes, as these determine the operation of the conditions you define here.
- When the drop-down is set to “in” (default), the Action will be performed when the request matches any of the fields ticked in the box beneath it.
- When set to “not in”, the Action will be performed when the request does not match the fields ticked in the box beneath it.
e.g. If “Payment types” “in” “American Express”, “Mastercard” and “Visa”
The Action will only be performed when the customer uses any of the aforementioned payment types.When creating a Condition, ensure that you specify at least one Request type and Error code. Failure to do so may cause unexpected issues.
-
When you have finished setting up the Condition, click “Save”.
-
Navigate to the Rule Manager, select the relevant Action type from the drop-down box and click “Go”.
Learn about the different Action types
-
Click “Add new action”.
-
You will be presented with a page allowing you to create a new Action. Type a unique and descriptive name into the “Action name” text field.
The page displayed is dependent on the type of Action you are creating. For example, the following is a screenshot of the page used to create a URL notification Action
You will need to carefully fill out the form, specifying the actions to be taken when the Condition is met.
When configuring an Action, we recommend having the documentation for the Action type to hand to better understand the different fields being displayed on screen, and also to learn about additional steps you may need to take that are specific to the Action type you have selected.
-
When you have finished setting up the Action, click “Save”.
-
Navigate to the Rule Manager.
-
From the top of the page, select the site reference for the Rule to be applied to. For new Conditions and Actions, you should select your test site reference, allowing you to test before deploying to your production environment. Once you have completed testing, you can repeat these steps to recreate the same rule on your live site reference.
Each Rule created is assigned to the one site reference you select here. To apply a Rule to multiple site references, you will need to recreate it for each site reference by following these steps again.
-
Select the relevant Action type from the drop-down box and click “Go”.
Learn about the different Action types
-
Use the drop-downs provided to assign a Condition to an Action. Then click "Create rule" to save.
New rules are set to status "Active" immediately upon creation, meaning they will start acting on all relevant requests from then onward. Please be mindful of this behaviour when saving any new rules to a live site reference.
If you do not see any Conditions and Actions in the drop-down boxes, you will need to create some by following the instructions in the sections above.
The drop-downs only contain Conditions and Actions you have created previously.
You cannot see Conditions and Actions created by other users.
When a rule is added successfully, this is confirmed with a green success message displayed at the top of the page and the on-screen table will update to show the new rule:
