Personal tools


Payment Gateway Allocator For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Payment Gateway Allocator For WHMCS

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.

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

  • Admin Area Features:
✔ Set Default Redirect Payment Gateways
✔ Set Default Credit Card Payment Gateways
✔ Add New Switching Rules To Payment Gateway Depending On Clients' Country And State
✔ Toggle Payment Gateways Module Usage Only - Hide All Other Payment Gateways
✔ Toggle Limitation Of Payment Gateways Depending On Country And State
  • Client Area Features:
✔ Pay Through Personalized Payment Gateways Adjusted To Location
✔ Change Payment Method Conveniently
  • General Info:
✔ Supports All Redirect And Credit Card Payment Gateways
✔ Supports Every Country And State
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.3
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.8 And Later
✔ Easy Module Upgrade To Open Source Version

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.


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.1 and later.
If you need a package for the previous versions of PHP, please contact our support.

PHP71 73.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

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.
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 here.

PHP56 73.png
Important: This situation does not affect the open source version of this module which can be applied to any PHP from version 5.6 and later.
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.

The content of the chosen PHP version files to upload should look like this.

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

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

Additional Steps Required

8. Now, proceed to 'Setup' 'Payments' 'Payment Gateways'.

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

PGS 7.png
9. Afterwards, move to 'Manage Existing Gateways' to rename them. Press 'Save Changes'.

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!


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.


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'.

Select '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.

PGS 9 1.png
Still, you have to set up 'Default Redirection Rules', no matter which option is selected in 'Gateway Settings'.


  • '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

Gateway Switches

'Gateways Switches' tab allows you to define switching rules per payment gateway.

You will find there a list of all active gateways in your system.

PGS 10.png

Creating New Switching Rules

In order to limit access to a selected payment gateway, press '+' button.
PGS 10 1.png
Select a country and states (optional). The gateway will be available for clients who do 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

Payment Gateways On The Order Form

Payment Gateway Allocator For WHMCS affects only client area. Let's take a look how the addon affects the payments 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
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


1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in 'Setup' → 'Payments' → 'Payment Gateways'.

Update Instructions

Essential guidance through the process of updating the module is offered here.

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!
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.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
Payment Gateway Allocator For WHMCS