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.|
|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.
|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.
| 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'.
|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'.
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.
|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'.
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.
|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.
|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.|
|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.
|Still, you have to set up 'Default Redirection Rules', no matter which option is selected in 'Gateway Settings'. |
Do not forget to save the changes when ready!
| '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.
Creating New Switching Rules
|In order to limit access to a selected payment gateway, press '+' button. |
|Select a country and states (optional). The gateway will be available for clients who do purchases in that region only.
Press 'Add' to complete.
|Repeat the process for all gateways you wish to limit. |
Use action buttons to edit rules or delete them.
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.|
'Credit Card Per Country / State' and 'Redirect Per Country / State' payment methods have been activated.
|In 'Setting' section option 'Module Gateway Only' has been selected together with two default gateways for 'Credit Card' and 'Redirection' payments.|
|Consequently, client may now choose only between:
In another scenario, in 'Settings' section of the module 'Apply Switching Rules' option is selected.
|In 'Gateway Switches' section, there is a rule forcing clients from United States to pay with '2CheckOut' payment gateway.|
|Consequently, client Test Tester, who is from USA, has no choice, but to pay with the enforced by the admin payment gateway.|
To allow all gateways in the client area, proceed to the addon → 'Settings' page and clear the settings.
|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.
|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.
|1. If you wish to forbid card payment or redirect payment, deactivate the related gateway in 'Setup' → 'Payments' → 'Payment Gateways'.|
|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!
|1. When you have problems with connection, check whether your SELinux or firewall does not block ports.|