A load balance profile will allow you to set a monthly cap, and load balance those limits between two or more gateway profiles on your campaigns. Before you can create a load balance profile, you will need to first make sure that your gateway profiles have been created under Payment Systems >Gateway Providers.
Once you have configured your gateway profiles, you will need to go to Payment Systems >Load Balance Profiles, and click on add load balance profile as shown in the illustration below:
In order to create a load balance profile, first you will need to select the currency for your profile, add the name and description of your profile, then select two or more gateway providers that were configured on the gateway configuration page by clicking on add gateway. Next, enter the monthly cap for each gateway in which the monthly cap is the dollar amount you desire to allocate per month to each gateway. Finally, just click on create load balance as shown in the illustration below. Once your load balance profile is created, then you can assign it to your campaign(s).
Preserve Billing: If this is checked, then this will allow transactions to always rebill on the gateway in which the initial order was created.
Editing a Load Balance Profile
When editing your load balance 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 fields and columns within the load balancer:
Daily vs. Monthly Weight Reset
If you would like a daily reset of your current weight percentage, then you will set the daily weight reset field to "yes". The daily reset will take place automatically at 5am EST each day. On the other hand, if you would like a monthly weight reset, then you will set the daily weight reset field to "no". The monthly reset will take place automatically at the beginning of each month.
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 load balancer will reserve 100% of your Reserve Forecasted Revenue for each gateway in your load balance 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 load balance profile during initial order processing. If a gateway in your load balance 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 load 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".
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 load balance 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 load balancer, then you will be able to use the remaining amount for that gateway in your existing or a different load balance profile, or use the amount for a single gateway on a different campaign.
This represents the monthly cap for each gateway within your load balance profile. The transactions that are presented to your load balance 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 load balance 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 load balancer.
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 load balance profile.
This represents the amount and percentage of available monthly cap for each gateway in your load balance profile.
Current Weight Percentage
This represents the weight percentage of the transactions that have been processed for each gateway in your load balance 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%.
Daily Initial & Subscription Reset
When you select ‘Yes’, the CRM will automatically reset both your initial and subscription counts at 11PM EST on a daily basis.
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.
Load Balance 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 load balancer 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 load balance 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 route 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 load balance 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 load balance 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. For further details on the MID Group Routing, please visit our Help Center HERE**
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
Advanced Campaign Routing
The advanced campaign routing option gives you the ability to route by payment types, products, countries, and BIN profiles to different gateways. After making your routing selection, just 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
1) Advanced routing takes precedence over Load Balance 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.
2) 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.
3) 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 CRM 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 load balance profile(s):
- Lime Light Load Balancer Maxed Out
- Lime Light Global Gateway Monthly Cap Maxed Out
- Lime Light Load Balancer Default Gateway Maxed Out
- Lime Light Load Balancer Advanced Routing By Products Had An Issue Finding A Valid Lime Light Product
- Lime Light Load Balancer Had A Problem Finding The Default Gateway Defined Because This Order Matched None Of The Load Balancer 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