Personal tools
Namespaces

Variants
Actions

Payment Gateway Allocator For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Payment Gateway Allocator For WHMCS)
(→‎About Payment Gateway Allocator For WHMCS)
 
(32 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
=About [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator Payment Gateway Allocator For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator Payment Gateway Allocator For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Payment Gateway Allocator For WHMCS''' allows you to set up available payment gateways depending on the country and the state from which your customers are.<br />
+
|style="padding: 10px 0px 10px 0px;"|'''Payment Gateway Allocator For WHMCS''' allows you to swap the available payment gateways and oblige single clients to cover their fees via a gateway of your preference.<br/> Set up the switching rules depending on the country and the state from which your customers are, their currency or a due invoice amount.<br />
−
The module supports all kinds of payment gateways as well as countries and states from all over the world.
+
The module supports all kinds of payment gateways, countries, states and currencies from all over the world.
 
|}
 
|}
 
<!-- This is a comment -->
 
<!-- This is a comment -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Set Default Redirect Payment Gateways
+
|style="padding: 10px 0px 0px 30px;"|✔ Set Switching Rules Per Payment Gateway And WHMCS Client Group
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Set Default Redirect Payment Gateways
 
|}
 
|}
 
{|
 
{|
Line 16: Line 19:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add New Switching Rules To Payment Gateway Depending On Clients' Country And State
+
|style="padding: 0px 0px 0px 30px;"|✔ Add New Switching Rules To Payment Gateway Depending On Clients':
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Country
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ State
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Currency
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Invoice Amount Threshold
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Switch Gateways Based On Allowed And Blocked Rule Types
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Copy Rule Settings From One Gateway To Another
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Exclude Chosen Clients From Gateway Switching Rules
 
|}
 
|}
 
{|
 
{|
Line 22: Line 46:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Limitation Of Payment Gateways Depending On Country And State
+
|style="padding: 0px 0px 0px 30px;"|✔ Toggle Limitation Of Payment Gateways Depending On Country And State
 
|}
 
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Toggle Fallback Plan To Display WHMCS Default Payment Gateways If No Switching Rules Are Met
 +
|}
 +
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  Pay Through Personalized Payment Gateways Adjusted To Location
+
|style="padding: 10px 0px 0px 30px;"|✔  Pay Through Personalized Payment Gateways Adjusted To Location, Currency And Order Amount
 
|}
 
|}
 
{|
 
{|
Line 36: Line 64:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Every Country And State
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Every Country, State And Currency
 
|}
 
|}
 
{|
 
{|
Line 42: Line 70:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.3
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.5 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator#open-source-version Open Source Version]
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator#open-source-version Open Source Version]
 
|}
 
|}
  
Line 68: Line 99:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
 
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.<br/> If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support].
+
In the most recent versions of the module, you will find only one package that supports PHP 7.3 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_73.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP73_81.png]]
 
|}
 
|}
 +
<!--
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>  
 
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>  
−
The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.<br/>
+
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
−
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
+
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
|style="padding: 0px 0px 10px 15px;"| '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 +
-->
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
−
The content of the chosen PHP version files to upload should look like this.  
+
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
Line 124: Line 157:
 
==Additional Steps Required==
 
==Additional Steps Required==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''8. Now, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. '' '''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''8. Now, proceed to '' 'Apps & Integrations' '' → '' 'Payments'.'' '''<br />
 
Find '' 'Redirect Per Country / State' '' and '' 'Credit Card Per Country / State' ''gateways and activate them.<br />
 
Find '' 'Redirect Per Country / State' '' and '' 'Credit Card Per Country / State' ''gateways and activate them.<br />
 
<!--'''Note: If you wish to forbid card payment or redirect payment, simply do not activate related gateway.''-->
 
<!--'''Note: If you wish to forbid card payment or redirect payment, simply do not activate related gateway.''-->
Line 132: Line 165:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Afterwards, move to '' 'Manage Existing Gateways' '' to rename them. Press '' 'Save Changes'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''9. Afterwards, move to '' 'System Settings' → 'Payment Gateways' '' to rename the just activated gateways.'''<br />
 
These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Payment Gateway Allocator.
 
These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Payment Gateway Allocator.
 
|}
 
|}
Line 152: Line 185:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:PGS_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_9.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Settings' '' select whether you want to allow only the two module gateways: '' 'Credit Card Per Country / State' '' and '' 'Redirect Per Country / State'. ''
+
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Settings' '' select whether you want to allow only the two module gateways: '' 'Credit Card Per Country / State' '' and '' 'Redirect Per Country / State'. ''<br/>'' '''Note:''' In order for the module to work correctly, you need to enable one of the options available in the 'Gateway Settings' section.''<br/>
−
Select '' 'Module Gateway Only' '' option -  then,  only the two above mentioned module gateways will be shown as payment options in the client area.<br />
+
* '' 'Module Gateway Only' '' option -  then,  only the two above mentioned module gateways will be shown as payment options in the client area.<br />
−
'' 'Apply Switching Rules' '' - if selected, only gateways allowed by the defined switching rules are allowed in client area as payment methods.
+
* '' 'Apply Switching Rules' '' - if selected, only gateways allowed by the defined switching rules are allowed in client area as payment methods.
 +
* '' 'Fallback Plan' '' - enable to display in the client area all the active WHMCS payment gateways if none of the gateway switching rules is met
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 25px;"|[[File:PGS_9_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_9_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 173: Line 207:
 
|}
 
|}
  
−
==Gateway Switches==
+
==Excluded Users==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Gateways Switches' '' tab allows you to define switching rules per payment gateway.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In the '' 'Excluded Clients' '' section, you can list clients who will be skipped when validating the gateway rules.<br/>
−
You will find there a list of all active gateways in your system.
+
Add clients to the list.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 25px;"|[[File:PGS_9_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Choose a clients from the list. Add client one by one.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_9_4.png]]
 +
|}
 +
 
 +
==Switching Rules==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|This module provides the flexibility to configure switching rules in two distinct manners.<br/>
 +
First, priority is given to client group rules, where assignments within a WHMCS client group take precedence. If a client belongs to a group with assigned rules, the allocation is determined based on these specifications.<br/> In the absence of group assignments or rules within the client's group, the module defaults to the basic "Gateway Switches" rules for the allocation of payment gateways.
 +
|}
 +
===Gateway Switches===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'' 'Gateways Switches' '' tab allows you to define basic switching rules per payment gateway. You will find there a list of all active gateways in your system. <br/>
 +
Precise instructions on how to create allocation rules can be found in the [[#Creating_New_Switching_Rules|Creating New Switching Rules]] section below.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_10.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_10.png]]
 
|}
 
|}
−
===Creating New Switching Rules===
+
 
 +
===Client Groups===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|In order to limit access to a selected payment gateway, press '' '+' '' button. <br/>
+
|style="padding: 10px 0px 15px 15px;"|Once you proceed to this section you will instantly see all the available in your WHMCS client groups ([https://docs.whmcs.com/Client_Groups more here]).<br/> Here you may define the payment gateway switching rules per each client group. You may assign rules to all your client groups or only some of them.<br/> Remember to set the client group status to '' 'Enabled','' otherwise, the group rules will not be taken into account when allocating the payment gateway.<br/>
 +
Press the "+" button to manage the selected group switching rules.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_13_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|As you can see on the screen below, available payment gateways have no switching rules created yet. Create rules, manage or copy existing rules between payment gateways.<br/> Precise instructions on how to create rules can be found in the [[#Creating_New_Switching_Rules|Creating New Switching Rules]] section right below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_13_1.png]]
 +
|}
 +
 
 +
====Creating New Switching Rules====
 +
{|
 +
|style="padding: 10px 0px 20px 15px;"|All the described below steps to create switching rules are accurate for both the '' 'Gateway Switches' '' and '' 'Client Groups'.''<br/>
 +
To limit access to a selected payment gateway, press the'' '+' '' button. <br/>
 
|}
 
|}
 
{|
 
{|
Line 189: Line 260:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Select a country and states ''(optional).'' The gateway will be available for clients who do purchases in that region only.  
+
|style="padding: 0px 0px 15px 15px;"|Select a country and state ''(optional).'' The gateway will be available for clients who make purchases in that region only.  
 
Press '' 'Add' '' to complete.
 
Press '' 'Add' '' to complete.
 
|}
 
|}
Line 196: Line 267:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Repeat the process for all gateways you wish to limit. <br/>
+
|style="padding: 0px 0px 15px 15px;"|Repeat the process for all gateways you wish to limit. <br/>
 
Use action buttons to edit rules or delete them.
 
Use action buttons to edit rules or delete them.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Perform the above steps for all active gateways that you wish to use. You may add rules per single gateway manually or copy rules from another gateway.<br/> To do so, simply press the marked button and choose the gateway whose rules you are going to copy. Remember to save the changes when ready.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Edit the rule, to move to the gateway settings.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|There define the gateway rules type:
 +
*'''Allowed''' - gateway by default is locked, after adding any rules within this gateway, it will become unlocked for clients who meet the rules
 +
*'''Blocked''' - gateway by default remains unlocked, after adding rules the gateway becomes blocked for adequate clients.<br/> For example check: [[#Payment_Gateways_On_The_Order_Form|Case Four]].<br/>
 +
Define the invoice threshold per enabled currency, provide the invoice value, and mark '' 'Greater' '' or '' 'Lower' '' to specify the rule performance. <br/>
 +
Remember to save the changes.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_12_4.png]]
 
|}
 
|}
−
 
 
<!--
 
<!--
 
===Modify Switching Rules===
 
===Modify Switching Rules===
Line 229: Line 324:
 
===Payment Gateways On The Order Form===
 
===Payment Gateways On The Order Form===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Payment Gateway Allocator For WHMCS affects only client area. Let's take a look how the addon affects the payments process.
+
|style="padding: 10px 0px 15px 15px;"|Payment Gateway Allocator For WHMCS affects only client area. Let's take a look at how the addon affects the payment process.
 
|}
 
|}
 
{|
 
{|
Line 270: Line 365:
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_15_3.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_15_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|In a similar scenario, for an unlogged customer intending to create a new account with the selected country set as the United States, the available payment gateway will be '' '2CheckOut' '' as well.<br/> However, should the client choose another country, the list of available payment gateways will automatically refresh based on any detected switching rules.
 
|}
 
|}
 
{|
 
{|
Line 291: Line 389:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_18.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Case Four:'''<br/>
 +
'' 'Authorize.net' '' gateway is marked as 'Allowed' for added rules.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_19_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Taking into account the above gateways settings and rules, a client from USA is allowed to choose among three gateways as visible on the screen below:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The same settings and rules bring the following consequences for a client from Russian Federation, that is, such client is allowed to use only one payment gateway.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_21.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in '' 'Setup' → 'Payments' → 'Payment Gateways'.''
+
|style="padding: 10px 0px 10px 15px;"|1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in '' 'Setup' → 'Payments' → 'Payment Gateways'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. In order to enable a gateway for all countries, simply set the single gateway '' 'Rules Type' '' to '''Blocked.'''
 
|}
 
|}
  
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
−
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
−
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
+
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/payment-gateway-allocator#open-source-version Open Source version] of your Payment Gateway Allocator For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>  
 +
 
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 
|}
 
|}
  

Latest revision as of 13:58, 26 April 2024

Contents

[edit] About Payment Gateway Allocator For WHMCS

Payment Gateway Allocator For WHMCS allows you to swap the available payment gateways and oblige single clients to cover their fees via a gateway of your preference.
Set up the switching rules depending on the country and the state from which your customers are, their currency or a due invoice amount.

The module supports all kinds of payment gateways, countries, states and currencies from all over the world.

  • Admin Area Features:
✔ Set Switching Rules Per Payment Gateway And WHMCS Client Group
✔ Set Default Redirect Payment Gateways
✔ Set Default Credit Card Payment Gateways
✔ Add New Switching Rules To Payment Gateway Depending On Clients':
✔ Country
✔ State
✔ Currency
✔ Invoice Amount Threshold
✔ Switch Gateways Based On Allowed And Blocked Rule Types
✔ Copy Rule Settings From One Gateway To Another
✔ Exclude Chosen Clients From Gateway Switching Rules
✔ Toggle Payment Gateways Module Usage Only - Hide All Other Payment Gateways
✔ Toggle Limitation Of Payment Gateways Depending On Country And State
✔ Toggle Fallback Plan To Display WHMCS Default Payment Gateways If No Switching Rules Are Met
  • Client Area Features:
✔ Pay Through Personalized Payment Gateways Adjusted To Location, Currency And Order Amount
✔ Change Payment Method Conveniently
  • General Info:
✔ Supports All Redirect And Credit Card Payment Gateways
✔ Supports Every Country, State And Currency
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

This tutorial will show you how to successfully install and configure Payment Gateway Allocator For WHMCS.

We will guide you step by step through the whole installation and configuration process.

[edit] Installation

1. Log in to our client area and download the module.
PGS 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.3 and later.

PHP73 81.png
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

Drte5t.png
4. When you install Payment Gateway Allocator For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/PaymentGatewayAllocator/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PGS 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

PGS 4.png

[edit] Configuration of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Payment Gateway Allocator' and press 'Activate' button.

PGS 5.png
7. In the next step you need to permit access to this module.

To do so click on 'Configure' button, tick 'Access Control' near desired admin role groups and press 'Save Changes'.

PGS 6.png

[edit] Additional Steps Required

8. Now, proceed to 'Apps & Integrations' → 'Payments'.

Find 'Redirect Per Country / State' and 'Credit Card Per Country / State' gateways and activate them.

PGS 7.png
9. Afterwards, move to 'System Settings' → 'Payment Gateways' to rename the just activated gateways.

These gateways will be used in place of any other gateway and forward all data to a gateway depending on configuration of Payment Gateway Allocator.

PGS 8.png
10. You have just successfully installed Payment Gateway Allocator For WHMCS!

[edit] Management

In this section we will show you the possibilities of Payment Gateway Allocator For WHMCS.

Our module allows you to define the availability of your payment gateways depending on your customers' country or state.

[edit] Settings

At the 'Settings' tab you can set up the module's behavior. Configure gateway settings and default redirection rules.
PGS 9.png
In 'Gateway Settings' select whether you want to allow only the two module gateways: 'Credit Card Per Country / State' and 'Redirect Per Country / State'.
Note: In order for the module to work correctly, you need to enable one of the options available in the 'Gateway Settings' section.
  • 'Module Gateway Only' option - then, only the two above mentioned module gateways will be shown as payment options in the client area.
  • 'Apply Switching Rules' - if selected, only gateways allowed by the defined switching rules are allowed in client area as payment methods.
  • 'Fallback Plan' - enable to display in the client area all the active WHMCS payment gateways if none of the gateway switching rules is met
PGS 9 1.png
Still, you have to set up 'Default Redirection Rules', no matter which option is selected in 'Gateway Settings'.

Choose:

  • 'Default CC Gateway' - it will be used with 'Credit Card Per Country / State' module gateway.
  • 'Default Redirection Gateway' - it will be used with 'Redirect Per Country / State' module gateway.

Do not forget to save the changes when ready!

PGS 9 2.png

[edit] Excluded Users

In the 'Excluded Clients' section, you can list clients who will be skipped when validating the gateway rules.

Add clients to the list.

PGS 9 3.png
Choose a clients from the list. Add client one by one.
PGS 9 4.png

[edit] Switching Rules

This module provides the flexibility to configure switching rules in two distinct manners.

First, priority is given to client group rules, where assignments within a WHMCS client group take precedence. If a client belongs to a group with assigned rules, the allocation is determined based on these specifications.
In the absence of group assignments or rules within the client's group, the module defaults to the basic "Gateway Switches" rules for the allocation of payment gateways.

[edit] Gateway Switches

'Gateways Switches' tab allows you to define basic switching rules per payment gateway. You will find there a list of all active gateways in your system.

Precise instructions on how to create allocation rules can be found in the Creating New Switching Rules section below.

PGS 10.png

[edit] Client Groups

Once you proceed to this section you will instantly see all the available in your WHMCS client groups (more here).
Here you may define the payment gateway switching rules per each client group. You may assign rules to all your client groups or only some of them.
Remember to set the client group status to 'Enabled', otherwise, the group rules will not be taken into account when allocating the payment gateway.

Press the "+" button to manage the selected group switching rules.

PGS 13 0.png
As you can see on the screen below, available payment gateways have no switching rules created yet. Create rules, manage or copy existing rules between payment gateways.
Precise instructions on how to create rules can be found in the Creating New Switching Rules section right below.
PGS 13 1.png

[edit] Creating New Switching Rules

All the described below steps to create switching rules are accurate for both the 'Gateway Switches' and 'Client Groups'.

To limit access to a selected payment gateway, press the '+' button.

PGS 10 1.png
Select a country and state (optional). The gateway will be available for clients who make purchases in that region only.

Press 'Add' to complete.

PGS 11.png
Repeat the process for all gateways you wish to limit.

Use action buttons to edit rules or delete them.

PGS 12.png
Perform the above steps for all active gateways that you wish to use. You may add rules per single gateway manually or copy rules from another gateway.
To do so, simply press the marked button and choose the gateway whose rules you are going to copy. Remember to save the changes when ready.
PGS 12 1.png
PGS 12 2.png
Edit the rule, to move to the gateway settings.
PGS 12 3.png
There define the gateway rules type:
  • Allowed - gateway by default is locked, after adding any rules within this gateway, it will become unlocked for clients who meet the rules
  • Blocked - gateway by default remains unlocked, after adding rules the gateway becomes blocked for adequate clients.
    For example check: Case Four.

Define the invoice threshold per enabled currency, provide the invoice value, and mark 'Greater' or 'Lower' to specify the rule performance.
Remember to save the changes.

PGS 12 4.png

[edit] Payment Gateways On The Order Form

Payment Gateway Allocator For WHMCS affects only client area. Let's take a look at how the addon affects the payment process.
Case One:

'Credit Card Per Country / State' and 'Redirect Per Country / State' payment methods have been activated.

PGS 13.png
In 'Setting' section option 'Module Gateway Only' has been selected together with two default gateways for 'Credit Card' and 'Redirection' payments.
PGS 14.png
Consequently, client may now choose only between:
  • 'Pay With Credit Card' option - in our case it will be 'SecurePay' gateway.
  • 'Proceed To Payment' option - in our case it will be '2CheckOut' gateway.
PGS 15.png
Case Two:

In another scenario, in 'Settings' section of the module 'Apply Switching Rules' option is selected.

PGS 15 1.png
In 'Gateway Switches' section, there is a rule forcing clients from United States to pay with '2CheckOut' payment gateway.
PGS 15 2.png
Consequently, client Test Tester, who is from USA, has no choice, but to pay with the enforced by the admin payment gateway.
PGS 15 3.png
In a similar scenario, for an unlogged customer intending to create a new account with the selected country set as the United States, the available payment gateway will be '2CheckOut' as well.
However, should the client choose another country, the list of available payment gateways will automatically refresh based on any detected switching rules.
Case Three:

To allow all gateways in the client area, proceed to the addon → 'Settings' page and clear the settings.

PGS 16.png
Let's check payment options in the client area once again. Now, your clients are able to pay using every active payment gateway.

However, when selecting 'Pay With Credit Card' or 'Proceed To Payment' option, client will be redirected to a gateway keeping any switching rules.

PGS 17.png
If you wish to hide only part of the gateways, for example only those for which switching rules are set, proceed to 'Setup' → 'Payments' → 'Payment Gateways'.

Afterwards, uncheck 'Show On Order Form' checkbox next to the desired gateway and press 'Save Changes'. Repeat this step for each gateway you wish to hide from the client area.

PGS 18.png
Case Four:

'Authorize.net' gateway is marked as 'Allowed' for added rules.

PGS 19 1.png
Taking into account the above gateways settings and rules, a client from USA is allowed to choose among three gateways as visible on the screen below:
PGS 20.png
The same settings and rules bring the following consequences for a client from Russian Federation, that is, such client is allowed to use only one payment gateway.
PGS 21.png

[edit] Tips

1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in 'Setup' → 'Payments' → 'Payment Gateways'.
2. In order to enable a gateway for all countries, simply set the single gateway 'Rules Type' to Blocked.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Payment Gateway Allocator For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Payment_Gateway_Allocator_For_WHMCS&oldid=66725"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Payment Gateway Allocator For WHMCS