June 7, 2012
Updated March 1, 2020
What is a Payment Routing Profile?
A Payment Routing Profile allows you to set monthly caps and payment routing limits between two or more gateway profiles on your campaigns. This allows you to have processing redundancy for your business. If an outage takes place with Gateway 1 and you are using this feature, all of your sales traffic would route to Gateway 2.
Before you can create a payment routing profile, make sure that your gateway profiles have been created under Settings > Providers. For more information on setting up your Gateway click here.
Once you have configured your gateway profiles, go to Payments>Payment Routing, and click on 'Add Payment Routing Profile':
Payment Routing Profiles can be accessed in the Main menu Payments> Payment Routing.
- Click the 'Action' Button and Select 'Add Payment Routing Profile'
- Select the Currency for the Routing Profile
- Create a Unique Name for the Payment Routing Profile
- Add a Description for this payment routing profile if you would like.
The following Image shows additional options and explanations available for each field:
Daily vs. Monthly Weight Reset
If you would like a daily reset of your current weight percentage, then set the daily weight reset field to "yes". If you prefer a monthly weight reset instead, then you set the daily weight reset field to "no". The monthly reset will take place automatically at the beginning of each month.
Daily Initial & Subscription Reset
When you select ‘Yes’, the system will automatically reset both your initial and subscription counts at 11 p.m. EST on a daily basis.
Allow $0 Initial/Subscr limit count: When you select Yes, all zero-dollar initial and subscription transactions will be counted in the Order Limits column configured below. If set to No, then only transactions greater than zero dollars will be counted in the Order Limits for both initials and subscriptions. Once an order limit is reached, the gateway will stop processing those transaction types until the totals are reset.
Reserve Forecast Percentages
If you would like to reserve a certain percentage of your reserve forecasted revenue for each billing cycle, then set the reserve forecast percentages field to “yes”. The percentage that is entered for each billing cycle will be the percentage that will be held as reserve revenue under the reserve forecasted revenue column. The percentage that is entered for the 5th+ cycle will apply to all subsequent cycles. If this field is set to "no", then the payment routing will reserve 100% of your Reserve Forecasted Revenue for each gateway in your payment routing profile.
Gateway Decline Limit
When you select "Yes", you will be able to set a gateway decline limit which pertains to the number of consecutive declines you wish to receive on each gateway in your payment routing profile during initial order processing. If a gateway in your payment routing profile reaches the decline limit after a consecutive number of declines during initial order processing, then the gateway will be set with a status of "Gateway Decline Limit Met" which makes it inactive. If a gateway in your payment routing profile receives an approval before reaching the gateway decline limit, then the number of consecutive declines for that gateway will be set back to "0".
Allow Reserve Gateways
This will allow you to reserve specific gateway(s) to take on transactions when all of your non-reserve gateways have maxed out.
3D Verify Routing
If set to Yes, transactions with 3D Verify tokens will automatically be routed to available 3D Verify enabled gateways. If set to No, then transactions will not take into account the 3D Verify tokens when routing to the next available gateway.
Strict Preservation: If set to yes, rebills will always attempt on the preserved gateway (if applicable), regardless of Advance Routing settings. If preserved gateway is maxed, rebills will be queued as non-billable, until cap is available. If set to no, advanced routing settings conflict rebills may not always route to the preserved gateway if advanced routing settings do not match the rebill transaction.
Payment Routing Profile Process:
Weighted: This is the default configuration that will balance transactions based on a current weight that derives from your monthly revenue from each gateway. The payment routing will attempt to keep your gateways evenly weighted throughout the month.
Round Robin: This configuration will evenly distribute transactions throughout your gateways, regardless of the result from the gateway - approval or decline. This means that each gateway will receive the same sheer amount of transactions throughout the month.
*Note*- If you add any initial or subscription order limits to your payment routing profile, the round robin sequence will automatically reset, starting with the lowest gateway ID within the profile.
User Defined Priority: This configuration will allow you to set a priority to your gateways. The system routes traffic to the gateway of the highest precedence until it is maxed out, at which point the system will move on to the gateway of the next highest precedence. When selecting ‘User Defined Priority’, an ‘Actions’ drop-down menu will appear with the ability to ‘Sort Gateway Priority’. This will lead you to a pop up allowing you to sort your gateways by dragging them to the appropriate order. This priority can be changed at any time throughout the month, without concern.
MID Group Routing:
The MID Group Routing setting will now “Group” or “Separate” multiple transactions from the same customer according to MID Group. This can be forced or preferred, depending on the strictness you wish to set on the rule. There are 4 different options to choose from as explained below.
Force - Group: Force will be a hard rule. If no available gateways match the MID group, the transaction will be declined.
Force – Separate: Force will be a hard rule. If there are no available gateways that have a different MID group, the transaction will be declined.
Preferred – Group: Prefer will be a soft rule. We will attempt to process the transaction on a gateway that matches the MID Group. If no available gateways match the MID group, it will fall back to the next payment routing process. i.e Weighted, Round Robin, User Defined Priority.
Preferred – Separate: Preferred will be a soft rule. We will attempt to process the transaction on a gateway with a different MID Group. If no available gateways match the MID group, it will fall back to the next payment routing process.
**This option only works with the NewOrderCardOnFile API method. Transactions from the same customer within the same day will be grouped or separated based upon the MID Group field which can be found in the Gateway Profile Merchant Account Details.
NOTE: These options will also work with any Advanced routing. i.e Force will have to match both Advanced routing rule AND MID Group rules to process
To Add Gateways from the gateway grid - click the add gateway button on the right side of the grid for the gateway line item you wish to add to this profile. Once selected enter the monthly cap for each gateway. This would be the dollar amount you desire to allocate per month to each gateway.
After you have selected all the Gateways that you wish to add to this profile - Click the ‘Green Create’ Payment Routing Profile button.
In the Select Gateway Grid Preserve Billing: If checked, then this will allow transactions to always rebill on the gateway in which the initial order was created.
Editing a Payment Routing Profile
When editing your payment routing profile, you are able to select additional gateway providers, disable or delete a gateway provider, or select options for advanced routing. The following provides a description of the additional fields and columns that are available within the payment routing profile edit function:
These are the options that are available to you in the Gateways Assigned to a Payment Routing Profile Grid:
Initial Order Limit
Enter the number of initial orders that are allowed per gateway. The initial order limit will apply to both initial subscription and non- subscription orders. Once the limit that is set on a gateway is reached, then no additional initial orders will be attempted on that gateway. Also, if you set the initial order limit to “0” on a particular gateway, then initial orders will no longer be attempted on that gateway.
Subscription Order Limit
Enter the number of subscription orders that are allowed per gateway. The subscription order limit will apply to orders in billing cycles 1 and greater. Once the limit that is set on a gateway is reached, then no additional subscription orders will be attempted on that gateway. Also, if you set the subscription order limit to “0” on a particular gateway, then subscription orders will no longer be attempted on that gateway.
Global Monthly Remaining
This represents the amount and percentage of global monthly cap available for each gateway in your payment routing profile. The global cap is established under the Fees and Descriptors section of a gateway profile when it is configured under Payment Systems>Gateway Providers.
Global Cap Remaining Allocation
This represents the amount of global cap that remains and is available for use. If there is a remaining allocation for a gateway in your payment routing, then you will be able to use the remaining amount for that gateway in your existing or a different payment routing profile, or use the amount for a single gateway on a different campaign.
This represents the monthly cap for each gateway within your payment routing profile. The transactions that are presented to your payment routing profile will rotate based on the monthly cap that is set in this field.
Reserved Forecasted Revenue
This represents the amount of revenue that is preserved for the current month on each gateway in your payment routing profile, including revenue from forced and cascaded transactions that are preserved on each gateway. Since this revenue is reserved for forecasted rebill transactions, it will be deducted from the remaining balance of each gateway in the payment routing.
Current Monthly Charges
This represents the current amount of revenue that has been charged for both initial and rebill transactions during the current month for each gateway in your payment routing profile.
This represents the amount and percentage of available monthly cap for each gateway in your payment routing profile.
Current Weight Percentage
This represents the weight percentage of the transactions that have been processed for each gateway in your payment routing profile. The weight percentage is calculated based on the current monthly charges against the monthly cap. For example, if the current monthly charges equal $10,000.00 and the monthly cap is $50,000.00, then the current weight percentage will equal 20%.
At the bottom of the Gateways Assigned List there are 3 Green Buttons. Their functionality is discussed here:
#1 Add A Single Gateway - If you select this button a pop up will display with a drop-down where you can select the gateway you would like to add to the profile.
#2 - Select Additional Gateway Providers - Clicking this button will display the grid with all of the gateways you have added to sticky.io. Here you can select multiple Gateways
#3 - Advanced Campaign Routing
The advanced campaign routing option gives you the ability to route by payment types, products, countries, BIN profiles, and Debit Settings to different gateways. After making your routing selection, select the default gateway, then click save. The default gateway is the fail-safe gateway that will be chosen if an order comes through that does not match any of the criteria within your advanced routing settings.
Pre-Auth Filter: The pre-auth amount will need to be set in this area if the pre-auth filter is enabled on your gateway.
Preserved Billing By-passed: The preserve billing feature will be by-passed when using the advanced routing feature.
Advanced Routing Rules
Advanced routing takes precedence over Payment Routing Profile Process (Weighted, Round Robin, User Defined Priority)
a) Gateways with 'Reserve Gateway' checked will not be routed to until all
non-reserved gateways are inactive.
If multiple Advanced Routing options (Payment Types, Product Ids, Billing Country, BIN Profile) are enabled, then the order must match all routing options selected for the gateway.
a) If the order doesn't match all routing options for any gateway, then the order
will be processed on the default gateway.
The BIN blocking Campaign configuration will take precedence over BIN profile Advanced Routing configuration.
Note: BIN blocking is checked before the gateway is chosen.
An email will be sent to all administrators of your account once the defined monthly limit amounts are at 90%. The following are a list of reasons a transaction may be decline by the system based on the configuration of your payment routing profile(s):
- sticky.io Payment Routing Maxed Out
- sticky.io Global Gateway Monthly Cap Maxed Out
- sticky.io Payment Routing Default Gateway Maxed Out
- sticky.io Payment Routing Advanced Routing By Products Had An Issue Finding A Valid sticky.io Product
- sticky.io Payment Routing Had A Problem Finding The Default Gateway Defined Because This Order Matched None Of The Payment Routing Rules
- Internal Error. No Order Id Found
- API passed forceGatewayId, but forceGatewayId value was not a valid gateway ID
- Campaign Daily Subscription Amount has been exceeded for the day
Once your payment routing profile is created, then you can assign it to your campaign(s).
If you update an Advanced Payment router, you will need to update it for every campaign that it is attached to.
Go to the Advanced Campaign Routing List and click the copy button at the end of the row as shown in the image below:
From there you'll need to select the campaign or campaigns that you would like to copy this updated Advanced Payment Router to. To select multiple items hold the SHIFT key and use the down-arrow or mouse to select the campaigns required.