Gateway Module Developer Docs
Creating a gateway module allows you to connect WHMCS to third party payment and credit card processors that aren’t natively supported in WHMCS as standard.
There are 2 core types of gateway module:
- Third Party Gateways – this is where the customer leaves your site to pay and is returned once the payment process is completed
- Merchant Gateways – this is where the customer enters credit card details directly on your website and the payment is then processed in the background (can also include 3D Secure where the user leaves your site)
So the first decision you need to make before starting your module for WHMCS is which type of gateway module you will be creating. Once you have that, you're ready to begin.
Getting Started
Template
We recommend you begin by downloading the gateway module template file from http://www.whmcs.com/members/dl.php?type=d&id=15
Choosing a Name
The naming convention for all modules in WHMCS is that they should be a single word, all lowercase, consisting of only letters and numbers, and always starting with a letter. The name must be unique among gateway modules and you can find all the existing module names in WHMCS by referring to the /modules/gateways/ directory.