Payment Gateways
Payment gateway modules allow you to accept payments of many types directly within WHMCS.
You can create your own gateway modules for WHMCS if you want to integrate with a gateway that WHMCS doesn’t offer by default. For more information, see our Developer Documentation.
You can access this feature at Configuration () > System Settings > Payment Gateways.
Activating a Payment Gateway
To activate a new payment gateway, find it in the list of payment gateways and click Activate. Then, configure the necessary gateway settings.
- To activate a payment gateway in WHMCS 8.6 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
- In WHMCS 8.5 and earlier, go to Configuration () > System Settings > Payment Gateways.
For steps to activate and configure a payment gateway, see Configure a Payment Gateway.
Payment Gateway Configuration
Each gateway has its own specific API requirements in order to process transactions, which vary from gateway to gateway.
For more information on your payment gateway’s configuration, see the documentation for that module.
All gateways can use the following settings:
| Option | Description |
|---|---|
| Show on Order Form | Whether to display the payment gateway on the order form and Client Area, subject to product group gateway restrictions. Also controls adding new payment details via the Admin Area for merchant gateways. |
| Display Name | The gateway’s name throughout the system and to clients (for example, an Authorize.net gateway could use the visible name Credit Card). |
| Convert To For Processing | If you use a payment gateway that doesn’t accept all of your currencies, you can choose a currency for WHMCS to convert to using the rates at Configuration () > System Settings > Currencies. For more information, see Convert Invoices to a New Currency. |
Supported Gateway Modules
WHMCS includes support for Merchant, Third-Party, Tokenization, and Manual gateways.
Merchant Gateways
Merchant Gateways store credit card information securely in the WHMCS database.
- Authorize.net
- BluePay
- Forte
- IP.Pay
- LinkPoint
- Merchant Partners
- Merchant Warrior
- Moneris
- NETbilling
- Navigate
- Netregistry Pay
- Offline Credit Card
- Optimal Payments
- PSIGate
- Pay Junction
- PayFlow Pro
- PayPal Card Payments
- PayPal Website Payments Pro
- Planet Authorize
- Quantum Gateway
- SecurePay
- SecurePay AU
- SecureTrading
- TrustCommerce
- Turkish Garanti Bank
- USA ePay
- WorldPay Invisible
- WorldPay Invisible XML
- eProcessingNetwork
Third-Party Gateways
Third-Party Gateways direct the client to the provider’s website to process payments off-site.
- 2CheckOut
- AsiaPay
- Authorize.net Echeck
- BidPay
- BitPay
- Boleto
- CCAvenue API v2
- CCAvenue Legacy
- CashU
- ChronoPay
- E-Gold
- E-Path
- F2B
- Gate2Shop
- GoCardless
- Modulo Moip
- NoChex
- PagSeguro
- PayPal Basic
- PayPal Checkout
- PayPoint.net
- Payment Express
- Payson
- SagePay Form
- Skrill
- Skrill 1-Tap
- SlimPay
- WorldPay
- iDeal via Mollie
- inpay
Tokenization Gateways
Tokenization Gateways reduce PCI liabilities for repeat billing by storing the original transaction details or a reference number (token) and not the full credit card number.
- Accept.js by Authorize.net
- Authorize.net CIM
- BluePay Remote
- BluePay e-Check
- Moneris Vault
- PayPal Payments
- PayPal Pro Reference Payments
- Quantum Vault
- SagePay
- SagePay Repeats
- SagePay Tokens v2
- Stripe
- Stripe ACH
- Stripe SEPA
- WorldPay FuturePay
- eWAY
Manual Gateways
Manual Gateways provide support for manual transactions in WHMCS.
Email Templates
The type of payment gateway that you select influences which invoice notification email template it sends.
- Third-party gateways send the Invoice Created email template.
- Merchant and tokenization gateways send the Credit Card Invoice Created email template.
This allows you to customize the payment instructions to clients for the different payment processes.
Attempt Capture
The type of payment gateway that you select influences the behavior when you click Attempt Capture on the invoice page in the Admin Area.
- For third-party gateways, the system will deactivate Attempt Capture because the client must click the payment button on the invoice to send payment.
- For merchant gateways and tokenization gateways, Attempt Capture will be active and staff can click to instantly capture payment from the client’s credit card.
Deactivating Gateway Modules
When you stop using a payment gateway, you must deactivate it. Deactivation prevents new payments using this gateway and will automatically reassign any services, invoices, transactions, and pay methods to the new payment gateway.
To deactivate a payment gateway, click Deactivate. The system will prompt you to select an alternative payment gateway. Make sure to change any currently-assigned items to this gateway.
Viewing Balances and Transactions
You can view payment gateway balances for Stripe™, PayPal Basic, PayPal Payments, and PayPal Card Payments at Billing > Transactions List in the WHMCS Admin Area. This lets you check your financial details sooner and stay aware of trends and changes.
- The displayed balances remain in the cache for a specific amount of time and will then automatically refresh. You can also manually refresh them.
- When you click on a transaction in this list, additional information will display for that transaction.
- Balances display by default for admins with the Full Administrator role. To make this information available to other admins, assign the View Gateway Balances permission to the desired role.
Test Credit Card Numbers
Gateways often have test modes that can use test card numbers. The common test card numbers below can generate successful test transactions, but they can vary from gateway to gateway.
You may use any expiration date in the future:
| Card Number | Description |
|---|---|
4007000000027 | Visa® Test Card |
4012888818888 | Visa Test Card II |
4000000000000002 | Visa Test Card III |
5424000000000015 | MasterCard® Test Card |
370000000000002 | American Express Test Card |
6011000000000012 | Discover Test Card |
3088000000000017 | JCB Test Card (Use expiration date 0905.) |
38000000000006 | Diners Club/Carte Blanche Test (Use expiration date 0905.) |
Last modified: June 14, 2024