Gateway Module For WHMCS Module Installation Guide
This guide will walk you through the steps to install a gateway module in WHMCS, ensuring that the module integrates smoothly into your system.
Prerequisites
- Access to your WHMCS installation (admin panel and server).
- The add-on module you want to install (usually provided as a
.zip
file).
Step 1: Download the Gateway Module
- Log into your Client Area.
- Go to My Services.
- Select the purchased product.
- In the Download section, you’ll find the latest module zip file available for download.
Step 2: Upload the Gateway Module to Your Server
To install the module, you’ll first need to upload it to the modules directory on your WHMCS installation.
-
Log in to your hosting server using FTP, cPanel File Manager, or SSH—whichever method you prefer.
-
Navigate to your WHMCS root directory, typically located at:
public_html/whmcs
-
Upload the module (folder and files) to the appropriate subfolder within the WHMCS root directory based on the structure of the gateway package you have:
If your package contains only gateway files (such as a .php file), upload it directly to:
/modules/gateways/
If your package includes multiple folders and files (such as /modules/gateways/gatewayname/, /callbacks/, or any other files intended for the WHMCS root or subdirectories), upload the files exactly as structured in the package. This may include:
/modules/gateways/
/modules/gateways/callbacks/
/modules/gateways/hooks/
/includes/
or any other specified directories.
Step 4: Activate the Module in WHMCS Admin Panel
Once the module is uploaded, it’s time to activate and configure it within the WHMCS admin panel.
-
Log in to the WHMCS Admin Area: Navigate to your WHMCS admin panel (typically
yourdomain.com/whmcs/admin
). -
Go to "Setup" > "Payment Gateways":
- In the left-hand sidebar, hover over
Setup
and click onPayment Gateways
under theGeneral Settings
section.
- In the left-hand sidebar, hover over
-
Locate the Installed Module:
- In the list of available gateways, find the newly uploaded gateway module.
-
Activate the Module:
- Click the Activate button next to the module name to enable it within WHMCS.