Revision as of 16:21, 21 April 2022

Payment gateway modules allow you to accept payments of many types directly within WHMCS.

You can access this feature at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.

Setting Up Gateway Modules

Each gateway has its own specific API requirements in order to process transactions, which vary from gateway to gateway. However, all gateways have three core options:

• 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.
• Visible 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 — When using multiple gateways, some gateways may not accept all the currencies you offer on your site. For those that don’t, you can choose a currency here for WHMCS to convert to before sending to them.
  • For example, if using Google Checkout with a UK account but offering prices in GBP and USD, you would need to select GBP in the Convert To box. This will use the rates in Configuration () > System Settings > Currencies or, prior to WHMCS 8.0, Setup > Payments > Currencies, to do the conversion. You can set this to auto-update daily.
  • For more information, see Converting Invoices to a New Currency.

Supported Gateway Modules

The following is a list of all the payment gateways that WHMCS includes by default:

• Merchant Gateways store credit card information securely in the WHMCS database.
• Third-Party Gateways take the client to the provider's website to process payments off-site.
• Tokenisation Gateways can perform repeat billing by storing the original transaction details or a reference number and not the full credit card number.
  • This reduces your PCI liabilities.
  • For more information, see Working with Tokenization.

For tokenisation gateways with the Remote Update Card feature, clients can enter their card details via the WHMCS Client Area. This is done via an interface hosted by the payment gateway directly or by paying an invoice. This creates a profile in the payment gateway's system that returns a token. WHMCS uses this to use for managing the card detail update requests via the Client Area and recurring payments. The full card details are not stored on your server, and, for some token gateways never touch it.

The type of payment gateway that you select influences which invoice notification email template it sends. Third-party gateways will send the Invoice Created email template, while merchant and tokenisation gateways will send the Credit Card Invoice Created email template. This allows you to customise the payment instructions to clients for the different payment processes.

The type of payment gateway also influences the behaviour of the Attempt Capture button on the invoice page in the admin area. For third-party gateways, the system will deactivate the button because the client needs to click the payment button on the invoice to send payment. For merchant gateways and tokenisation gateways, the button will be active and staff can click Attempt Capture to instantly capture payment from the client's credit card.

Any gateways showing in blue below indicate that further information relating to the setup and use of that gateway is available by clicking on the name.

Merchant Gateways

Tokenisation Gateways

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the system won't add the token to WHMCS until someone has submitted a payment through the module. The system will store the credit card details in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. After the payment is complete, the system fetches the token and replaces the credit card details in the database. Storage of the credit card details can also happen when the client updates their credit card details or when they place an order and it does not process the payment immediately.

Third Party Gateways

Custom Gateways

It is also possible to 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.

Deactivating Gateway Modules

Deactivate Gateway

If you no longer wish to use a particular payment gateway, clicking Deactivate beside the name will gracefully remove the gateway from the system. This will prevent any further payments using this gateway and automatically reassign any products, services, invoices, transactions and pay methods to the new payment gateway.

When you click the deactivate link, a window will appear and prompt the user to select an alternative payment gateway, to which you should change any currently-assigned items.

Migrating Payment Gateways

Sometimes, you may want to stop using one payment gateway and switch to another. For more information, see Migrating Payment Gateways.

Test Credit Card Numbers

Gateways often have test modes where you can use test card numbers. The common test card numbers are below and should generate successful test transactions, but they can vary from gateway to gateway. You may use any expiration date in the future.

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)

Troubleshooting

For help to troubleshoot payment gateways, see General Troubleshooting and the documentation for your specific gateway.