Create and Manage Payment Gateway Routing Rules
Learn how to create and manage custom rules for routing payments through preferred gateways, including handling fallback scenarios.
Introduction
With the Payment Gateway Routing feature enabled, you are able to define your own custom rule for processing payments through preferred gateways. The rules determine when to route transactions to preferred payment gateways and to handle fallback scenarios in case those transactions fail.
A rule is presented as a route map, which consists of one trigger, one or more conditions, and actions:
- The trigger determines when to trigger the defined rule.
- The condition defines how to categorize payments and generates rule branches, based on attributes of payments or payment methods.
- The action assigns a gateway instance to payments that match the condition of a branch.
The following table describes the components supported in Payment Gateway Routing rules.
|
Component |
Type |
Description |
|---|---|---|
|
Trigger |
Payment Trigger |
When initializing an electronic payment through an API operation, a manual operation from the UI, or a payment run, the Payment Gateway Routing rule is triggered. |
|
Condition |
Payment Condition |
Use any of the following attributes of payments to categorize transactions and generate branches of the rule:
|
|
Payment Method Condition |
Use any of the following attributes of payment methods to categorize transactions and generate branches of the rule:
| |
|
Split Traffic Condition |
Define the percentage of payment volumes processed on two different branches. The sum of these numbers must be 100. | |
|
Response Condition |
Perform an in-transaction retry with another payment gateway based on the Gateway Response Code without needing to wait for another retry cycle. The Response Condition can only be used behind an Assign Gateway Action. Up to two in-transaction retries are allowed in a branch. This means behind the first Assign Gateway Action, you can use the Response Condition - Assign Gateway Action pair at most twice. Payment gateways used in in-transaction retries must support the Sharing NTI feature . | |
|
Action |
Assign Gateway |
Assign a payment gateway instance to a branch of the rule. This payment gateway will be used to process payments that match the conditions of this branch. If you select Use Default Gateway , the default gateway of the customer account takes precedence over the default gateway of the tenant. The Assign Gateway Action is either the end of a branch or followed by a Response Condition to do an in-transaction retry. |