WHMCS supports a variety of payment gateway modules that allow resellers to process payments directly within the WHMCS platform. Configuring payment gateways is essential for resellers to securely and efficiently accept payments from clients. Additionally, WHMCS provides options to develop custom gateway modules for integrations beyond default offerings. For more information, see the WHMCS Developer Documentation.
Pre-requirements
- Active WHMCS installation (version 8.6 or later recommended)
- Administrative access to WHMCS
- API keys and account details for the selected payment gateways
Accessing Payment Gateway Settings
To manage payment gateways in WHMCS, navigate to:
- WHMCS 8.6 and Later:
Configuration > Apps & IntegrationsorAddons > Apps & Integrations - WHMCS 8.5 and Earlier:
Configuration > System Settings > Payment Gateways
Activating a Payment Gateway
- In the Payment Gateways section, locate the desired gateway module.
- Click Activate next to the gateway name.
- Complete the required configuration fields specific to the gateway.
- Click Save Changes to enable the gateway.
General Payment Gateway Configuration Options
Each payment gateway has unique configuration requirements. However, the following options are standard across all gateways:
| Option | Description |
|---|---|
| Show on Order Form | Determines whether the gateway is visible in the Client Area order form. Controls client access for adding new payment methods in the Admin Area for merchant gateways. |
| Display Name | The name displayed to clients throughout the system (e.g., “Credit Card” for Authorize.net). |
| Convert To For Processing | If the gateway doesn’t support all currencies, WHMCS can convert to an available currency using rates from Configuration > System Settings > Currencies. |
Supported Gateway Types
WHMCS supports four main types of payment gateways:
- Merchant Gateways: Store credit card information securely within WHMCS. Examples include Authorize.net, BluePay, and PayPal Website Payments Pro.
- Third-Party Gateways: Redirect clients to the provider’s site to process payments off-site. Examples include 2CheckOut, BitPay, and PayPal Basic.
- Tokenization Gateways: Reduce PCI liabilities by storing a token instead of full card information for repeat billing. Examples include Stripe, eWAY, and SagePay Tokens.
- Manual Gateways: Allow for manual payment processes like bank transfers or mail-in payments.
Configuring Common Gateway Modules
Merchant Gateways
- Examples: Authorize.net, BluePay, PayPal Website Payments Pro
- Store card information securely in WHMCS for repeated billing and instant payment captures.
Third-Party Gateways
- Examples: 2CheckOut, PayPal Basic, BitPay
- Redirects clients to the provider’s site to complete the payment.
Tokenization Gateways
- Examples: Stripe, SagePay Tokens, PayPal Pro Reference Payments
- Enables secure tokenized billing, minimizing PCI responsibilities for resellers.
Manual Gateways
- Examples: Bank Transfer, Direct Debit, Mail-In Payment
- Provides alternative payment methods that require manual confirmation.
Supported Third-Party, Tokenization, and Merchant Gateways in WHMCS
Note: Please double-check all URLs before opening an account or entering any sensitive information to ensure they are legitimate. Adopting best practices, such as verifying URLs and using reputable security tools, can help protect your data when visiting external links.
| Gateway Type | Gateway Name | Link |
|---|---|---|
| Third-Party Gateways | 2CheckOut | 2CheckOut |
| AsiaPay | AsiaPay | |
| Authorize.net Echeck | Authorize.net Echeck | |
| BidPay | BidPay | |
| BitPay | BitPay | |
| Boleto | Boleto | |
| CCAvenue API v2 | CCAvenue API v2 | |
| CCAvenue Legacy | CCAvenue Legacy | |
| CashU | CashU | |
| ChronoPay | ChronoPay | |
| GoCardless | GoCardless | |
| Modulo Moip | Modulo Moip | |
| NoChex | NoChex | |
| PagSeguro | PagSeguro | |
| PayPal Basic | PayPal Basic | |
| PayPal Checkout | PayPal Checkout | |
| PayPoint.net | PayPoint.net | |
| Payment Express | Payment Express | |
| Payson | Payson | |
| SagePay Form | SagePay Form | |
| Skrill | Skrill | |
| SlimPay | SlimPay | |
| WorldPay | WorldPay | |
| iDeal via Mollie | iDeal via Mollie | |
| inpay | inpay | |
| Tokenization Gateways | Accept.js by Authorize.net | Accept.js by Authorize.net |
| Authorize.net CIM | Authorize.net CIM | |
| BluePay Remote | BluePay Remote | |
| Moneris Vault | Moneris Vault | |
| PayPal Payments | PayPal Payments | |
| PayPal Pro Reference Payments | PayPal Pro Reference Payments | |
| Quantum Vault | Quantum Vault | |
| SagePay Tokens v2 | SagePay Tokens v2 | |
| Stripe | Stripe | |
| Stripe ACH | Stripe ACH | |
| Stripe SEPA | Stripe SEPA | |
| WorldPay FuturePay | WorldPay FuturePay | |
| eWAY | eWAY | |
| Merchant Gateways | Authorize.net | Authorize.net |
| BluePay | BluePay | |
| Forte | Forte | |
| IP.Pay | IP.Pay | |
| Merchant Partners | Merchant Partners | |
| Moneris | Moneris | |
| NETbilling | NETbilling | |
| Pay Junction | Pay Junction | |
| PayFlow Pro | PayFlow Pro | |
| PayPal Card Payments | PayPal Card Payments | |
| SecurePay | SecurePay | |
| USA ePay | USA ePay | |
| WorldPay Invisible | WorldPay Invisible |
Payment Attempt Capture
The payment gateway type influences how payment captures work in WHMCS:
- Third-Party Gateways: The client must manually click the payment button on the invoice to complete the transaction. Attempt Capture will be deactivated.
- Merchant and Tokenization Gateways: Staff can click Attempt Capture to capture payments directly from the Admin Area.
Deactivating a Payment Gateway
- Go to
Configuration > System Settings > Payment Gateways. - Click Deactivate for the gateway you wish to stop using.
- Follow the prompt to assign invoices and transactions to an alternative gateway if necessary.
Viewing Balances and Transactions
WHMCS 8.2 and later allows viewing balances for specific gateways (e.g., Stripe, PayPal) at Billing > Transactions List. Balances refresh periodically, and you can also manually refresh them. Only administrators with View Gateway Balances permission can access this data.
Testing Payment Gateways
Many gateways support test modes with specific test card numbers:
| Card Number | Description |
|---|---|
| 4007000000027 | Visa® Test Card |
| 5424000000000015 | MasterCard® Test Card |
| 370000000000002 | American Express Test Card |
| 6011000000000012 | Discover Test Card |
Best Practices and Gotchas
- Use Secure API Keys: Ensure that API keys and credentials are stored securely.
- Enable SSL: Use HTTPS for secure payment processing and compliance.
- Regularly Monitor Balances: Keep track of payment gateway balances for trend analysis and financial planning.
