WHMCS Documentation - User contributions [en]

Payment Gateways

2019-03-26T13:05:40Z

NickH: /* Third Party Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[EWAY Rapid 3.1]] || [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]
|-
| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[Stripe]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || ||
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[Authorize.net#Echeck_Module|Authorize.net Echeck]]
| width="33%" | [[Bank Transfer]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[BitPay]]
|-
| [[CashU]] || [[CC Avenue]] || [[ChronoPay]]
|-
| [[F2B|Cobrança - F2b]] || [[Direct Debit]] || [[e-Path]]
|-
| [[Forte]] || [[Gate2Shop]] || [[GoCardless]]
|-
| [[IDEALMollie|iDeal via Mollie]] || [[inpay]] || [[Mail In Payment]]
|-
| [[Modulo Moip]] || [[NoChex]] || [[PagSeguro]]
|-
| [[Paymate AU and NZ]] || [[Payment Express]] || [[Paymex]]
|-
| [[PayPal]] || [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]]
|-
| [[Payson]] || [[Payza]] || [[Planet Authorize]]
|-
| [[Skrill]] || [[Skrill 1-Tap]] || [[SlimPay]]
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Email

2019-02-26T13:06:46Z

NickH:

== Overview ==
The Email registrar module is used when manually taking care of customers' domain registrations and management. This can occur when using a domain registrar that does not have an API or a registrar that does not presently have an integration with WHMCS.

The module does not connect to any registrar to automatically register, transfer, or make changes to any domains. Rather, in place of automatic connections, it will send an email to predefined contacts alerting them to the requested registration, transfer, or other change. This allows your staff to make the changes manually and update your system.

When a domain registration, transfer or renewal invoice is paid by a client an email will be sent to staff notifying them manual action is required.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
}}
== Activation ==
To activate and begin using the Email registrar module, follow the steps below:

# Login to your WHMCS Admin Area
# Navigate to Setup > Products/Services > Domain Registrars
# Locate Email Notifications in the list
# Click the '''Activate''' button
# Enter the email addresses you wish to notify
# Click Save Changes to complete the process

== Client Area Screenshot ==
[[File:EmailRegistrar.jpg|800px]]

{{modules}}

Email

2019-02-26T13:06:34Z

NickH:

== Overview ==
The Email registrar module is used when manually taking care of customers' domain registrations and management. This can occur when using a domain registrar that does not have an API or a registrar that does not presently have an integration with WHMCS.

The module does not connect to any registrar to automatically register, transfer, or make changes to any domains. Rather, in place of automatic connections, it will send an email to predefined contacts alerting them to the requested registration, transfer, or other change. This allows your staff to make the changes manually and update your system.

When a domain registration, transfer or renewal invoice is paid by a client an email will be sent to staff notifying them manual action is required.

{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
}}
== Activation ==
To activate and begin using the Email registrar module, follow the steps below:

# Login to your WHMCS Admin Area
# Navigate to Setup > Products/Services > Domain Registrars
# Locate Email Notifications in the list
# Click the '''Activate''' button
# Enter the email addresses you wish to notify
# Click Save Changes to complete the process

== Client Area Screenshot ==
[[File:EmailRegistrar.jpg|800px]]

{{modules}}

Email

2019-02-26T13:06:20Z

NickH:

== Overview ==
The Email registrar module is used when manually taking care of customers' domain registrations and management. This can occur when using a domain registrar that does not have an API or a registrar that does not presently have an integration with WHMCS.

The module does not connect to any registrar to automatically register, transfer, or make changes to any domains. Rather, in place of automatic connections, it will send an email to predefined contacts alerting them to the requested registration, transfer, or other change. This allows your staff to make the changes manually and update your system.

When a domain registration, transfer or renewal invoice is paid by a client an email will be sent to staff notifying them manual action is required.

{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
}}

== Activation ==
To activate and begin using the Email registrar module, follow the steps below:

# Login to your WHMCS Admin Area
# Navigate to Setup > Products/Services > Domain Registrars
# Locate Email Notifications in the list
# Click the '''Activate''' button
# Enter the email addresses you wish to notify
# Click Save Changes to complete the process

== Client Area Screenshot ==
[[File:EmailRegistrar.jpg|800px]]

{{modules}}

Email

2019-02-26T13:05:57Z

NickH:

{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
}}

== Overview ==
The Email registrar module is used when manually taking care of customers' domain registrations and management. This can occur when using a domain registrar that does not have an API or a registrar that does not presently have an integration with WHMCS.

The module does not connect to any registrar to automatically register, transfer, or make changes to any domains. Rather, in place of automatic connections, it will send an email to predefined contacts alerting them to the requested registration, transfer, or other change. This allows your staff to make the changes manually and update your system.

When a domain registration, transfer or renewal invoice is paid by a client an email will be sent to staff notifying them manual action is required.

== Activation ==
To activate and begin using the Email registrar module, follow the steps below:

# Login to your WHMCS Admin Area
# Navigate to Setup > Products/Services > Domain Registrars
# Locate Email Notifications in the list
# Click the '''Activate''' button
# Enter the email addresses you wish to notify
# Click Save Changes to complete the process

== Client Area Screenshot ==
[[File:EmailRegistrar.jpg|800px]]

{{modules}}

Planet Authorize

2019-02-12T14:23:33Z

NickH:

==Overview==
Planet Authorize is a credit card merchant gateway that is integrated with WHMCS. It is designed to be used with any payment gateway that offers Authorize.net emulation. It can also be used as a duplicate Authorize.net gateway.

==Setup==
To activate the Planet Authorize module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose Planet Authorize from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.

To identify the "Submission URL" of your gateway, please refer to the instructions from your merchant gateway on their Authorize.net emulation.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refunds = yes
}}

{{modules}}

Planet Authorize

2019-02-12T14:23:17Z

NickH:

==Overview==
Planet Authorize is a credit card merchant gateway that is integrated with WHMCS. It is designed to be used with any payment gateway that offers Authorize.net emulation. It can also be used as a duplicate Authorize.net gateway.

==Setup==
To activate the Planet Authorize module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose Planet Authorize from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.

To identify the "Submission URL" of your gateway, please refer to the instructions from your merchant gateway on their Authorize.net emulation.

{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refunds = yes
}}

{{modules}}

2CheckOut

2019-02-12T14:18:35Z

NickH:

{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

==Setup==
Begin by activating the payment gateway under '''Setup > Payments > Payment Gateways''' and choose ''2CheckOut'' from the All Payment Gateways tab.

Once activated, you can then enter the configuration details explained below.

[[File:1_config.png|2CO Configuration]]

===Notifications===

[[File:2co-ins.JPG|thumb|2CO Notifications Setup]]

To setup the callback process for 2CheckOut to automatically mark invoices paid, you will need to login to your 2CheckOut account and click the '''Integrations''' tab:
* First click ''Enable INS" and "Enable global URL"
* In the '''Global URL''' field, enter the url http://www.yourdomain.com/whmcs/modules/gateways/callback/tco.php . Replacing http://www.yourdomain.com/whmcs/ with the actual URL of your WHMCS installation.
* Click ''Update''

===Direct Return===

In order to return clients back to your WHMCS installation after a successful payment you can configure Direct Return within the 2CheckOut control panel:

* Navigate to '''Integrations'''
* Under the Redirect URL heading, in the Approved URL field set the URL to
** https://www.yourdomain.com/whmcs/modules/gateways/callback/2checkout.php
* Be sure to replace http://www.yourdomain.com/whmcs/ with the actual URL of your WHMCS installation.

===Checkout Style===

Two checkout styles are made available as part of 2CheckOut configuration:

* '''Inline Checkout''' - Inline Checkout is an iframe payment option which displays a secure payment form as an overlay when your client is making payment. This allows for payment to be taken from a client without them leaving your site. WHMCS recommends this checkout style when using 2CheckOut.
* '''Standard Checkout''' - Standard Checkout will redirect a client to the 2CheckOut site to make payment before they are redirected back to your site.

===API Username/Password===

[[File:2co-api-new.JPG|thumb|2CO API User Setup]]

If you wish to be able to use the '''inline, recurring billing and automatic refunds functionality''' within WHMCS, then you must setup a 2CheckOut API user and enter the details in these fields.

To setup an API user, you will need to first login to your 2CheckOut account and go to '''Settings > Manage User Access > View Roles > Add Role''' and ensure enable '''Manage api access''' is ticked. You then need to go to '''Settings > Manage User Access > View Users > Add User''' and create a new user, assigning it to the role just created. Finally, enter the username & password that you just created into the appropriate API username and API password fields inside WHMCS.

===Secret Word===

For Security, a secret word is set inside your 2CheckOut account, this must be entered into WHMCS for notifications and client redirects to be successful:
* In your 2Checkout Account Navigate to "''Integrations''"
* Copy the INS Secret Word displayed or generate a new one
* Paste the INS Secret Word into the ''Secret Word'' field of the 2CheckOut configuration within the WHMCS administration.

===Recurring Billing===
This option allows you to choose the options your clients have to pay when viewing an invoice, or going through the checkout process.
A recurring payment with 2CheckOut is automatically sent when due without the need for the client to login and pay again. No card details are saved in WHMCS when using 2CheckOut.
====Offer Recurring & One Time Payments====
Allow the choice to your clients by providing both Recurring and One Time Billing options.

====Offer Recurring Only====
Only provide a recurring button to your clients. The button will only appear when there is a recurring item on the invoice, and when the invoice is not overdue.

====Offer One Time Only====
Only provide the option for One Time payments to your clients. No automatic recurring payments will be received.

===Skip 2CO Fraud Check===
Ticking this option will prevent 2Checkout from performing their fraud checks on payments. It can result in faster processing of payments, but may potentially increase your exposure to fraudulent orders and charge-backs.

Should a payment that has been recorded in WHMCS later be determined to be fraudulent, manual action would be required to reverse the payment recorded in WHMCS and suspend any services as appropriate.

===Convert To For Processing===
This option will only appear in a multi-currency installation. It is very important that this be set to the value of the currency your 2Checkout account is held in. For example, if your 2Checkout account is held in USD, then the "Convert To For Processing" setting must also be set to USD. If this is not set properly, your payments may fail.

==Error Messages==

===Demo Mode===

In order to use demo mode, the "Demo Setting" in your 2CheckOut account should be set to "Parameter" under '''Account > Site Management'''. Demo mode can then be enabled by ticking the checkbox in WHMCS under '''Setup > Payments > Payment Gateways'''.

Please note that when using demo mode, all callbacks from 2CheckOut will fail with the error MD5 Hash Failure if a secret word is specified. This is done intentionally by 2Checkout to protect those who sell digital goods from fraudulent purchases through their demo mode.

<div class="docs-alert-info">
In Demo Mode, valid credit card data must be submitted in order to properly perform the request. Credit cards will not be charged during this process.
</div>

===MD5 Hash Failure===

An MD5 Hash Failure error under '''Billing > Gateway Log''' indicates that the Secret Word in '''Setup > Payments > Payment Gateways''' does not match the Secret Word in the 2CheckOut control panel. Double check your entry is exactly right, and check for any invisible trailing spaces if so.

===Authentication failed===

This error in the Gateway Log indicates that either the secret word, API username, or API password are incorrect. These may be reconfigured at '''Setup > Payments > Payment Gateways'''. For further information on this configuration [[#API_Username.2FPassword|see above]].

{{modules}}

2CheckOut

2019-02-12T14:16:29Z

NickH:

{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

==Setup==
Begin by activating the payment gateway under '''Setup > Payments > Payment Gateways''' and choose ''2CheckOut'' from the All Payment Gateways tab.

Once activated, you can then enter the configuration details explained below.

[[File:1_config.png|2CO Configuration]]

===Notifications===

[[File:2co-ins.JPG|thumb|2CO Notifications Setup]]

To setup the callback process for 2CheckOut to automatically mark invoices paid, you will need to login to your 2CheckOut account and click the '''Integrations''' tab:
* First click ''Enable INS" and "Enable global URL"
* In the '''Global URL''' field, enter the url http://www.yourdomain.com/whmcs/modules/gateways/callback/tco.php . Replacing http://www.yourdomain.com/whmcs/ with the actual URL of your WHMCS installation.
* Click ''Update''

===Direct Return===

In order to return clients back to your WHMCS installation after a successful payment you can configure Direct Return within the 2CheckOut control panel:

* Navigate to '''Integrations'''
* Under the Redirect URL heading, in the Approved URL field set the URL to
** https://www.yourdomain.com/whmcs/modules/gateways/callback/2checkout.php
* Be sure to replace http://www.yourdomain.com/whmcs/ with the actual URL of your WHMCS installation.

===Checkout Style===

Two checkout styles are made available as part of 2CheckOut configuration:

* '''Inline Checkout''' - Inline Checkout is an iframe payment option which displays a secure payment form as an overlay when your client is making payment. This allows for payment to be taken from a client without them leaving your site. WHMCS recommends this checkout style when using 2CheckOut.
* '''Standard Checkout''' - Standard Checkout will redirect a client to the 2CheckOut site to make payment before they are redirected back to your site.

===API Username/Password===

[[File:2co-api-new.JPG|thumb|2CO API User Setup]]

If you wish to be able to use the '''inline, recurring billing and automatic refunds functionality''' within WHMCS, then you must setup a 2CheckOut API user and enter the details in these fields.

To setup an API user, you will need to first login to your 2CheckOut account and go to '''Settings > Manage User Access > View Roles > Add Role''' and ensure enable '''Manage api access''' is ticked. You then need to go to '''Settings > Manage User Access > View Users > Add User''' and create a new user, assigning it to the role just created. Finally, enter the username & password that you just created into the appropriate API username and API password fields inside WHMCS.

===Secret Word===

For Security, a secret word is set inside your 2CheckOut account, this must be entered into WHMCS for notifications and client redirects to be successful:
* In your 2Checkout Account Navigate to "''Integrations''"
* Copy the INS Secret Word displayed or generate a new one
* Paste the INS Secret Word into the ''Secret Word'' field of the 2CheckOut configuration within the WHMCS administration.

===Recurring Billing===
This option allows you to choose the options your clients have to pay when viewing an invoice, or going through the checkout process.
A recurring payment with 2CheckOut is automatically sent when due without the need for the client to login and pay again. No card details are saved in WHMCS when using 2CheckOut.
====Offer Recurring & One Time Payments====
Allow the choice to your clients by providing both Recurring and One Time Billing options.

====Offer Recurring Only====
Only provide a recurring button to your clients. The button will only appear when there is a recurring item on the invoice, and when the invoice is not overdue.

====Offer One Time Only====
Only provide the option for One Time payments to your clients. No automatic recurring payments will be received.

===Skip 2CO Fraud Check===
Ticking this option will prevent 2Checkout from performing their fraud checks on payments. It can result in faster processing of payments, but may potentially increase your exposure to fraudulent orders and charge-backs.

Should a payment that has been recorded in WHMCS later be determined to be fraudulent, manual action would be required to reverse the payment recorded in WHMCS and suspend any services as appropriate.

==Error Messages==

===Demo Mode===

In order to use demo mode, the "Demo Setting" in your 2CheckOut account should be set to "Parameter" under '''Account > Site Management'''. Demo mode can then be enabled by ticking the checkbox in WHMCS under '''Setup > Payments > Payment Gateways'''.

Please note that when using demo mode, all callbacks from 2CheckOut will fail with the error MD5 Hash Failure if a secret word is specified. This is done intentionally by 2Checkout to protect those who sell digital goods from fraudulent purchases through their demo mode.

<div class="docs-alert-info">
In Demo Mode, valid credit card data must be submitted in order to properly perform the request. Credit cards will not be charged during this process.
</div>

===MD5 Hash Failure===

An MD5 Hash Failure error under '''Billing > Gateway Log''' indicates that the Secret Word in '''Setup > Payments > Payment Gateways''' does not match the Secret Word in the 2CheckOut control panel. Double check your entry is exactly right, and check for any invisible trailing spaces if so.

===Authentication failed===

This error in the Gateway Log indicates that either the secret word, API username, or API password are incorrect. These may be reconfigured at '''Setup > Payments > Payment Gateways'''. For further information on this configuration [[#API_Username.2FPassword|see above]].

{{modules}}

Email

2019-02-12T14:12:49Z

NickH:

{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
}}

The Email registrar module is used when manually taking care of customers' domain registrations and management. This can occur when using a domain registrar that does not have an API or a registrar that does not presently have an integration with WHMCS.

The module does not connect to any registrar to automatically register, transfer, or make changes to any domains. Rather, in place of automatic connections, it will send an email to predefined contacts alerting them to the requested registration, transfer, or other change. This allows your staff to make the changes manually and update your system.

When a domain registration, transfer or renewal invoice is paid by a client an email will be sent to staff notifying them manual action is required.

The recipient email addresses are specified in the module configuration under Setup > Products/Services > Domain Registrars.

[[File:EmailRegistrar.jpg]]

{{modules}}

File:EmailRegistrar.jpg

2019-02-12T14:12:13Z

NickH: Screenshot of Email Registrar client area

Screenshot of Email Registrar client area

Email

2019-02-12T14:11:48Z

NickH:

Order Form Issues

2019-01-28T12:54:07Z

NickH: /* Extension not listed in includes/whoisservers.php */

==There was an error in your request==
When checking a domain availability this indicates that your firewall is blocking the whois port; 43. Please ensure port 43 is open.
It could also indicate your server is unable to connect to the whois server listed in the /includes/whoisservers.php file - ensure your server is able to connect to the whois server on port 43 for the TLD listed in this file.

==There was a problem connecting to the domain registry==
When checking a domain availability this indicates that your firewall is blocking the whois port; 43. Please ensure port 43 is open.
It could also indicate your server is unable to connect to the whois server listed in the /includes/whoisservers.php file - ensure your server is able to connect to the whois server on port 43 for the TLD listed in this file.

==Domain Checker reports domains available when they are registered==
The cause of this problem is the same as the above two points; a connection problem with the whois server. Begin by reviewing '''Utilities > Logs > Activity Log''' for any error messages beginning with ''WHOIS Lookup Error'' at the time of performing the domain availability check. Some potential errors are explained below:

===Extension not listed in includes/whoisservers.php===
WHMCS can check the availability of over 800 domain extensions as standard. Unfortunately, the domain you are looking up is not amongst them. However, this can be added by modifying the /includes/whoisservers.php file and entering the WHOIS server details for the desired TLD.

Further information is [[Domains_Configuration#Adding_Additional_WHOIS_Services|published here]].

===Error: 110 - Connection Error===
This error indicates that your firewall is blocking the whois port; 43. Please ensure port 43 is open.
It could also indicate your server is unable to connect to the whois server listed in the /includes/whoisservers.php file - ensure your server is able to connect to the whois server on port 43 for the TLD listed in this file.

===Error: 0 - php_network_getaddresses: getaddrinfo failed: Name or service not known===
This indicates that an entry does exist in the /resources/domains/dist.whois.json file for the TLD in question or your server is unable to resolve it.

Double-check with the [https://www.iana.org/domains/root/db/ IANA database] that you're connecting to the correct whois server, and if not it can be added or changed by [[WHOIS_Servers|following these instructions]].
If the entry for the TLD in question does exist, speak to your server admin to investigate why you server is unable to resolve it.

===Error detail unknown===
[[#Error:_110_-_Connection_Error|See Connection Error above]]

===eNom Namespinner===
For errors beginning with ''eNom Namespinner:'' please refer to [[Domain_Namespinning#Troubleshooting|Domain Namespinning Troubleshooting]].

==Invalid TLD/Registration Period Supplied for Domain Registration==
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=JB_IZAKMYw4&hd=1|Watch Video Tutorial]]

This error indicates an order has been placed for a TLD or registration period that hasn't been configured. Please review the following video to resolve the issue: http://www.youtube.com/watch?v=JB_IZAKMYw4&hd=1

==An order cannot be created because no products or domain registration items have been selected==
Same as above; this error indicates an order has been placed for a TLD or registration period that hasn't been configured. Please review the following video to resolve the issue: http://www.youtube.com/watch?v=JB_IZAKMYw4&hd=1

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=JB_IZAKMYw4&hd=1|Watch Video Tutorial]]

==Order form not displaying domain results==
This problem manifests itself as follows; during the product ordering price after selecting the "Use an existing domain and change the nameservers" option and clicking "Go", no results are returned.

This problem is caused by Cloudflare script minification/Rocketloader features. This causes Cloudflare to replace the javascripts WHMCS uses to check the availability with their own copies. Cloudflare's javascripts do not contain the necessary code.

Please disable RocketLoader and script minification options in your Cloudflare control panel.

==Free domains do not show as free on product configuration step==
When configuring an order, the domain will show as full price until the checkout page. This is because the discount is reliant upon the client selecting the appropriate TLD, product and billing cycle, so cannot be applied until both the domain and product are in the cart with the billing cycle selected so WHMCS knows that they're eligible to receive the free domain.

==Product price displays a smaller amount on the cart than configured==
This is caused by the [[Ordering_Tab#Monthly_Pricing_Breakdown|Monthly Pricing Breakdown]] feature. If you do not wish prices displayed in this way, it can be disabled under '''Setup > General Settings > Ordering tab'''.

==Product is configured as prorata but no pro-rating is occurring==
Problem: You have ticked the "Prorata" option in a product's Pricing tab with in the admin area, but upon ordering the price is not being pro-rated.
Solution: This is caused by the [[Ordering_Tab#Signup_Anniversary_Prorata|Signup Anniversary Prorata]] feature which overrides the product prorata setting. If you'd rather products be po-rated to a specific date rather than the client's signup date, this option can be disabled under '''Setup > General Settings > Ordering tab'''.

{{troubleshooting}}

Email

2019-01-14T17:59:52Z

NickH:

{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
}}

The Email registrar module is used when you are manually taking care of your customers' domain registrations and management. This can occur when you are using a domain registrar that does not have an API or a registrar that does not presently have an integration with WHMCS.

The module does not connect to any registrar to automatically register, transfer, or make changes to any domains. Rather, in place of automatic connections, it will send an email to predefined contacts alerting them to the requested registration, transfer, or other change. This allows your staff to make the changes manually and update your system.

When a domain registration, transfer or renewal invoice is paid by a client an email will be sent to staff notifying them manual action is required. The recipient email addresses are specified in the module configuration under Setup > Products/Services > Domain Registrars.

{{modules}}

Payment Reversals

2019-01-14T17:49:48Z

NickH: /* What does it do? */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

==What are Payment Reversals?==
A payment reversal is when a transaction paid to you is returned to the buyer. This typically happens after a chargeback or having lost a dispute with a customer (i.e. a lost PayPal claim).

In this situation, it is common to want to reverse the actions that a transaction triggered when it was originally received. This is what the Payment Reversals feature in WHMCS can automate for you.

==What does it do?==

For supported gateways, WHMCS can automatically reverse a payment when a notification is received from a payment gateway about a reversal:

* [[GoCardless]]
* [[PayPal]]
* [[SlimPay]]

Supported reversal actions include:

* '''Change Invoice Status''' - Set Invoice to Collections Status. The collections status for invoices in WHMCS is used to denote an invoice which is a bad debt and can be used to track invoices which have received chargebacks or been reversed as a result of a lost dispute.
* '''Change Due Dates''' - Reverts Next Due Date Increments for the products and services contained within an invoice. This has the effect of making the item be considered due again, and in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment is made.

==Enabling Automated Payment Reversals==

To enable Automated Payment Reversal handling, navigate to Setup > Automation Settings and ensure the checkboxes are ticked for the '''Change Invoice Status''' and '''Change Due Dates''' settings.

==Email Notifications==

When a payment reversal notification is received, WHMCS will send an email notification to all admin users with a role group that is set to receive "Account Emails". See [[Administrators_and_Permissions#Managing_Administrator_Roles|Managing Administrator Roles]] for more information.

==Making a Manual Payment Reversal==

[[File:payment_reversal.png|750px]]

A manual payment reversal can be performed when adding a refund to an invoice.

Simply check the '''Reverse Payment''' when making the refund and the invoice status and next due dates will be reversed as appropriate.

==Reversal Actions for Given Items==

The reversal actions performed can vary depending upon the products/services contained with an invoice as follows.

;Hosting & Hosting Addons Invoice

: Any hosting and hosting addons that are part of the invoice for the reversed transaction will have their next due dates automatically reverted.
:If the payment reversal occurs as part of the cron, automatic suspend, if enabled, will occur next.
:If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.

;Domain Items
:Domain items will need to be manually managed. There is no automatic action taken with domains when a Payment Reversal occurs.

;Upgrade Invoice

:The service associated with the upgrade will be immediately suspended.

;Add Funds Invoice

:The credit applied to the client account will be immediately removed. This could leave a client with a negative credit balance.

;Mass Payment Invoice

:Each invoice that has been paid will have a reversed transaction applied to it and the invoice will be set to Collections.

;ProRated Hosting & Hosting Addons
:The next due date of the items on the invoice will be set to the previous due date.
:If the payment reversal occurs as part of the cron, automatic suspend, if enabled, may occur next.
:If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.

;Custom Items

:Nothing can occur with custom invoice items. There is no relationship in WHMCS that can be utilised.

Payment Reversals

2019-01-14T17:47:57Z

NickH: /* What are Payment Reversals? */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>

==What are Payment Reversals?==
A payment reversal is when a transaction paid to you is returned to the buyer. This typically happens after a chargeback or having lost a dispute with a customer (i.e. a lost PayPal claim).

In this situation, it is common to want to reverse the actions that a transaction triggered when it was originally received. This is what the Payment Reversals feature in WHMCS can automate for you.

==What does it do?==

For supported gateways, WHMCS can automatically reverse a payment when a notification is received from a payment gateway about a reversal:

* [[GoCardless]]
* [[PayPal]]
* [[SlimPay]]

Supported reversal actions include:

* '''Change Invoice Status''' - Set Invoice to Collections Status. The collections status for invoices in WHMCS is used to denote an invoice which is a bad debt and can be used to track invoices which have received payment disputes or chargebacks.
* '''Change Due Dates''' - Reverts Next Due Date Increments for the products and services contained within an invoice. This has the effect of making the item be considered due again, and in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment is made.

==Enabling Automated Payment Reversals==

To enable Automated Payment Reversal handling, navigate to Setup > Automation Settings and ensure the checkboxes are ticked for the '''Change Invoice Status''' and '''Change Due Dates''' settings.

==Email Notifications==

When a payment reversal notification is received, WHMCS will send an email notification to all admin users with a role group that is set to receive "Account Emails". See [[Administrators_and_Permissions#Managing_Administrator_Roles|Managing Administrator Roles]] for more information.

==Making a Manual Payment Reversal==

[[File:payment_reversal.png|750px]]

A manual payment reversal can be performed when adding a refund to an invoice.

Simply check the '''Reverse Payment''' when making the refund and the invoice status and next due dates will be reversed as appropriate.

==Reversal Actions for Given Items==

The reversal actions performed can vary depending upon the products/services contained with an invoice as follows.

;Hosting & Hosting Addons Invoice

: Any hosting and hosting addons that are part of the invoice for the reversed transaction will have their next due dates automatically reverted.
:If the payment reversal occurs as part of the cron, automatic suspend, if enabled, will occur next.
:If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.

;Domain Items
:Domain items will need to be manually managed. There is no automatic action taken with domains when a Payment Reversal occurs.

;Upgrade Invoice

:The service associated with the upgrade will be immediately suspended.

;Add Funds Invoice

:The credit applied to the client account will be immediately removed. This could leave a client with a negative credit balance.

;Mass Payment Invoice

:Each invoice that has been paid will have a reversed transaction applied to it and the invoice will be set to Collections.

;ProRated Hosting & Hosting Addons
:The next due date of the items on the invoice will be set to the previous due date.
:If the payment reversal occurs as part of the cron, automatic suspend, if enabled, may occur next.
:If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.

;Custom Items

:Nothing can occur with custom invoice items. There is no relationship in WHMCS that can be utilised.

Clients:Products/Services Tab

2018-12-18T14:03:30Z

NickH: /* Cancelling a Service */

<br/><br/>{{Client Management}}

The Products/Services tab is accessed via the '''Clients > View/Search Clients''' page, select a client, then click the tab marked "Products/Services". It contains details for all a client's services, as well as the ability to edit, upgrade/downgrade, move to another client, delete and run module commands.
[[File:client_services.png|thumb|Client Products/Services Tab]]

==Managing a Client's Products/Services==

You can locate products/services to manage in a number of ways:

#Search for the Client in '''Clients > View/Search Clients''', and then from the '''Client Summary''' page click the ID of the product you want to manage from the list
#Search for the Product in '''Clients > List All Products/Services > Search/Filter''', then click the product ID or domain to be taken to the product details
#Using the [[Admin_Area#Search|Intelligent Search]]

The Products/Services details page inside a clients profile allows you to view and modify all of a products settings. After making any changes, you need to click the '''Save Changes''' button to save your edits.

The first few fields are fairly self-explanatory, such as domain, username, password, dedicated IP and status.

==Payment Settings==

===First Payment Amount===

The sum total due for the initial payment for this service. It includes the product price + configurable options + any setup fee - discounts.

This value will be used to generate an invoice when Registration Date = Next Due Date

===Recurring Amount===

The sum total that will be invoiced for this service on renewal. It includes the product price + configurable options - discounts.

This value will be used to generate an invoice when Registration Date =/= Next Due Date

===Auto Recalculate on Save===

*This checkbox option located to the bottom right of the product details screen updates the recurring amount field when checked
*It can be used after changing the product, configurable options, billing cycle or promo code to auto calculate the new recurring price
*It is off by default so that any discounted rates or custom pricing are not overwritten as these aren't taken into account by it

===Next Due Date===

The date upon which the next renewal invoice is due to be paid. A renewal invoice will be generated in advance of this date in accordance with the [[Automation_Settings]] for the Recurring Amount.

For one-time services the field is not used so will display "N/A" instead.

===Billing Cycle===

The frequency with which the product will be invoiced.

For example if this is set to "Monthly" and the Recurring amount "5.00", the client will be invoiced 5.00 once per month for this service. Similarly if this is set to "Annually" and the Recurring amount "50.00", the client will be invoiced 50.00 once per year for this service.

Changing the value will not by itself change the price the client is invoiced, to do this tick the [[#Auto Recalculate on Save]] checkbox before clicking Save Changes.

===Payment Method===

Defines the payment method used for invoices generated by this service. With this option it's possible to use a different payment gateway for each of a client's services.

The client may ultimately pay using a different payment method if permitted in the [[Invoice_Tab#Clients_Choose_Gateway|General Settings]].

===Promotion Code===

If you wish to apply a promotional discount to this service, select it from this dropdown menu. Changing the value will not by itself change the price the client is invoiced, to do this tick the [[#Auto Recalculate on Save]] checkbox before clicking Save Changes.

===Subscription ID===

Certain third party payment gateways (namely PayPal and 2Checkout) use this field to store the ID number of their recurring subscriptions. It means that when a payment is made by thye subscription it can be associated with this service in WHMCS.

==Running Module Commands==

If the product/service is linked to a module, you will have a Module Commands row towards the bottom of the page. This allows you to execute any of the commands available in that module. Modules can have custom functions but the most common ones are:

*'''Create''' - runs the creation routine and sets the product status to active
*'''Suspend''' - runs the suspension routine and sets the product status to suspended. You will be prompted to enter a suspension reason, leave it blank if the client has an unpaid invoice and you want the account automatically unsuspended when paid.
*'''Unsuspend''' - runs the unsuspension routine and sets the product status back to active
*'''Terminate''' - runs the termination routine and sets the product status to terminated
*'''Change Package''' - runs the upgrade/downgrade routine for the selected product
*'''Change Password''' - runs the password modification routine for the last saved password value

==Addons==

*Product addons allow you to bill for additional items related to the main product but on independant billing cycles from the product (unlike Configurable Options which have to bill on the same cycle)
*Addons can be preconfigured in '''Setup > Product Addons''' but you can also create custom addons for specific clients which aren't predefined for flexibility
*Preconfigured addons can be ordered by clients from the client area product details page

===Mananging Addons===

*The Products/Services details page shows the number of addons a product has with a '''Click here to Manage''' link just below the domain field
*To view/edit or delete addons you need to click that link and a popup will open
*Any existing addons will be displayed with edit and delete icons for managing them

====Adding Addons to Users====

*To add a new addon, click '''Products/Services''' in Clients Profile.
*Next click on the link '''Click here to Manage''' beside the Addons label, and then click '''Add New Addon''' button.
*If using a predefined addon, simply choose it from the dropdown and leave the name, price and billing cycle fields empty as they will all be automatically set
*Alternatively, if adding a custom addon specific to this client, leave the Predefined Addon set to None and enter a custom name, price and cycle
*If you would like to invoice for the new addon immediately then you don't need to do anything as that will happen by default, or alternatively if you don't want to invoice yet you can just untick the generate invoice checkbox
*Once happy with the selections, click '''Save Changes''' to complete the process

===Override Auto Suspension===

*This option can be used to allow extra time for payment to be made for specific individuals
*It allows you to set a date to hold the suspension until and then it will only suspend if it's still unpaid when that date is reached
*The checkbox to enable it is at the bottom of the '''Products/Services''' details tab under a '''Clients Profile'''
*Tick that box and then in the date field that appears, choose the date you want to override the auto suspension until
* Entering the date 00/00/0000 will permanently prevent the product from being suspended.

==Cancelling a Service==

===Auto Terminate/Fixed Term===
You can setup products to automatically terminated after a set number of days from the date of signup. For more information refer to [[Products_and_Services#Pricing_Tab|Configuring Products/Services]].

===Clients Self Service===
WHMCS can completely automate the process of product cancellation or wait for manual confirmation. To do this navigate to '''Setup > General Settings > Other''' and enable the '''Show Cancellation Link''' option.

Clients can then request cancellation of any of their products & services directly from the client area.

To fully automate cancellation and have the module terminate command run (for example to remove the hosting account from the server) tick the '''Setup > Automation Settings > Cancellation Requests''' option.

Now when the cron runs any services with a cancellation request due today will be removed from the server and the status changed in WHMCS to Cancelled. The process runs as follows:

*Client clicks ''Request Cancellation'' button on the product details page in client area
*They're prompted to provide a cancellation reason and provided 2 choices for the cancellation - either '''Instant''' (on next cron run) or at the '''End of the Current Billing Cycle'''.
*If a matching domain exists under the client's account in active status with ''Auto Renew'' enabled, the customer is given the option to disable auto renew too - thereby leaving the domain to expire.
*Any unpaid invoices for the product will be cancelled ([[Invoice_Tab#Cancellation_Request_Handling|if enabled]])
*A notification email is sent to administrators and you will be able to review the reason provided in '''Clients > Cancellation Requests'''.

====Manual Cancellation====
If the Cancellation Request setting is '''not''' enabled then at this point you must navigate to the cancellation requests page, click through to the service page and click the '''Terminate''' module command button to remove the account from the server. The cancellation request is then moved from the ''Open Requests'' page to ''Completed Requests''.

====Automated Cancellation====
If the Cancellation Request setting '''is''' enabled the cancellation request will be actioned when the daily automation cron runs on the appropriate day. For example if the ''Immediate'' option was selected it will be terminated on the next cron run, if ''End of Billing Period'' was selected it will be terminated when the cron runs on the service's Next Due Date.

=====One Time / Free Products=====
WHMCS will not automatically process any cancellations for products that have no future due date such as Free or One Time products. If your client submits a cancellation request for this type of product, it will need to be processed manually. As of Version 7.7, the cancellation button will no longer show on products that are Free or One Time.

===Admin Scheduled Cancellations===

As an admin user, you can schedule the termination of a product at the end of the currently active period by going to the Products/Services tab, ticking the '''Auto-Terminate End of Cycle''' option and optionally entering a reason/note for it. Any unpaid invoices for the product will be cancelled and will suppress any further renewal invoices from generating for this product and terminate it when the next due date is reached.
The "Cancellation Requests" setting in '''Setup > Automation Settings''' must also be enabled.

===Admin Immediate Cancellation===

Finally, if you want to cancel or terminate a product or service immediately then you simply need to locate the item you wish to cancel, and from the Products/Services page, click the '''Terminate''' button if the product is linked to a module or if not, manually change the dropdown status from Active to '''Cancelled'''. Once you've done this, no further invoices will generate for the item.

==Upgrades/Downgrades==

===Admin Area===

If you would like to change the product/service a client is assigned to and automatically charge or credit the difference for that change then you need to use the Upgrade/Downgrade process. You'll find the option for this next to the Products/Services dropdown menu on the Products/Services Details page within the clients profile. To use it, simply navigate to the product you want to change, click the Upgrade/Downgrade link, and in the popup that appears make the new product & billing cycle selections as required and it will give you a preview of what the charge will be for the remainder of the current cycle and allow you to create an order/invoice for that change if happy.

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=wXEulukuHdo|Watch Video Tutorial]]

There will no immediate changes to the product after creating an upgrade order, the actual product or config option changes won't take effect until the invoice is paid. But as soon as the invoice is paid the product will be updated, the new recurring amount will be set, and with most supported control panels the upgrade is fully automated with the new package details/changes being passed over to the server module being used. Finally the upgrade email specified in the product configuration is sent to the user advising them of the new products details.

The same process can also be used for configurable options changes and billing the difference for those if the product contains them.

===Client Side===

Clients can also place orders for upgrades & downgrades themselves if you have permitted it in the product configuration. This allows clients to order upgrades/downgrades and complete them automatically without the need for any staff involvement.

For more information, including how to allow clients upgrades and how the upgrade charges are calculated, please refer to the [[Automated Upgrades and Downgrades]] section

===Manual Upgrades===
There may be occasion when you wish to make an upgrade without placing an upgrade order (such as a free upgrade) or processing the upgrade before the client has paid for it. To achieve this:

#Navigate to the client's Products/Services tab,
#Change the product from the dropdown menu,
#Tick "Auto Recalculate on Save" checkbox,
#Click Save Changes,
#Finally click the "Change Package " Module Command button to make the change on the server.

==Moving a Service to another Client==
[[File:Transfer product.png|thumb|Transfer Product Popup]]
#From the Products/Services tab of the service you want to move, click '''Move Product/Service to Another Client''' located at the top-right of the page
#A popup box will appear (you will need popup blockers disabled to use this)
#In the popup enter the ID of the new owner. If you don't know the client's ID the Search field can be used to search by name, company or email address. Click the client's name and the ID will be filled in.
#After selecting the desired click, click the '''Transfer''' button
#The item will then be transferred, the window will close, and the original window will refresh to show the product under its new owner.

'''N.B.''' Moving a products/service between clients within WHMCS will not have any affect on the account on the server.

===Invoices===
Invoices cannot be moved between clients, therefore when moving a product/service any invoices will remain under the old owner. Therefore it would be advisable to check the old owner's Invoices tab for any unpaid invoices for this service and cancel them. If you wish to invoice the new owner for the service, move the Next Due Date forward/back by one day and a new invoice will be generated when the cron next runs.

==Misc. Options==

===Admin Notes===

Here staff can enter private notes about the client to be displayed to other staff viewing this service under the Products/Services tab. Notes entered here are separate from those entered under any other service, domain or the client's Summary tab.

===Deleting a Product/Service from a Client===

#From the Products/Services details page of the product you want to delete, scroll to the bottom and click the red '''Delete''' link
#After clicking this link, you will be asked to confirm if you are sure you want to delete the item
#If you click No you will be returned to the page, if you click Yes, the item will be deleted and you will be taken to the next product/service under that client

'''Note:''' Deleting a product from WHMCS will not terminate it on the server. If you wanted to remove it from the server aswell, you need to run the Terminate Module Command as explained above before deleting the record from WHMCS.

===Send Message===

Use the dropdown located at the bottom of the page to send a 'Product' type email template to the client, or select the "New Message" option to compose a new email from scratch. General and Domain type emails can be sent using the dedicated dropdowns under the Summary and Domain tabs.

===Resending Product Welcome Email===
To re-send a product welcome email simply navigate to the client's Products/Services tab and click the "Resend Product Welcome Email" button at the bottom of the page.

HotFixes

2018-11-14T16:35:15Z

NickH:

Hot-Fix patch files are made available to address specific issues in releases. Please be sure to only apply patches that are valid for the version of WHMCS you have installed. Instructions to apply the fix may vary from case to case. Please read in full.

<div class="docs-alert-info">
<span class="title">Looking for Version 7?</span><br />
Hotfixes for version 7.0 and above are located here: https://whmcs.community/files/categories/
</div>

==Version 6.3.0==

'''CORE-9907 - Prevent fatal error on domain renewal'''
Full Details: http://forum.whmcs.com/showthread.php?112798
Steps to Apply: Upload the single file contained within the zip folder to the includes directory
Download Link: http://www.whmcs.com/download/842/prevent-fatal-error-on-domain-renewal

==Version 5.3.12==

'''CORE-8348 - Prevent Email Reopening rendering incorrectly in General Settings when enabled'''
Full Details: http://forum.whmcs.com/showthread.php?98506
Steps to Apply: Upload the single file contained within the zip folder to the admin directory
Download Link: http://www.whmcs.com/download/694/render-prevent-email-reopening-correctly

'''CORE-8351 - Domain renewal email template days until nextdue merge field always zero'''
Full Details: http://forum.whmcs.com/showthread.php?98503
Steps to Apply: Upload the single file contained within the zip folder to the includes directory
Download Link: http://www.whmcs.com/download/690/domain-days-until-nextdue

==Version 5.3.10==

'''Case 5197 - Can't access admin area in Windows environments'''
Full Details: http://forum.whmcs.com/showthread.php?93382
Steps to Apply: Upload the single file contained within the zip folder to the root directory
Download Link: http://www.whmcs.com/download/666/windows-admin-directory-fix

==Version 5.3.9==

'''Case 5077 - Two-Factor Auth redirecting to Admin Login for 5.3.9'''
Full Details: http://forum.whmcs.com/showthread.php?92550
Steps to Apply: Upload the single file contained within the zip folder to the admin directory
Download Link: http://www.whmcs.com/download/650/admin-two-factor-first-login-fix

==Version 5.3.6==

'''Case 4339 - Email CSS Styling not applying'''
Steps to Apply: Upload the single file contained within the zip folder to /includes/classes/WHMCS/
Download Link: http://www.whmcs.com/download/610/email-css-styling-fix

==Version 5.3.4==

'''Case 4116 - Doman Registration Fix'''
Steps to Apply: Upload the files as set out within the zip folder to your root WHMCS directory
Download Link: http://www.whmcs.com/download/582/domains-reg-fix

==Version 5.3.3==

'''Case 4061 - WorldPay Callback Fix'''
Steps to Apply: Upload the single file contained within the zip file to the /modules/gateways/callback/ folder
Download Link: http://www.whmcs.com/download/566/worldpay-callback-fix

'''Case 4016 - Gateway Parameters Fix'''
Full Details: http://forum.whmcs.com/showthread.php?85218
Steps to Apply: Upload the single file contained within the zip file to the /includes/classes/WHMCS/ folder
Download Link: http://www.whmcs.com/download/562/gateway-params-fix

==Version 5.2.13==

'''Case 3663 - Client Area Currency Switching Problem'''
Full Details: http://forum.whmcs.com/showthread.php?81910
Steps to Apply: Upload the single file contained within the zip file to the /includes/ folder
Download Link: http://www.whmcs.com/download/490/currency-switching-hotfix-52

'''Case 3671 - Insert Predefined Reply in Admin Open Ticket not working'''
Full Details: http://forum.whmcs.com/showthread.php?81990
Steps to Apply: Upload the single file contained within the zip file to the /admin/ folder
Download Link: http://www.whmcs.com/download/494/admin-new-ticket-predefined-52

'''Case 3672 - Add Predefined Product in Quotes not working'''
Full Details: Clicking the Add a Predefined Product link when creating or editing a quote leads to an invalid token error
Steps to Apply: Upload the single file contained within the zip file to the /admin/ folder
Download Link: http://www.whmcs.com/download/498/admin-quotes-predefined-product-52

==Version 5.2.12==

'''Case 3471 - Ticket Attachment Downloads Fail in First Ticket Message (Does not affect replies)'''
Full Details: http://forum.whmcs.com/showthread.php?80718&p=344703#post344703
Steps to Apply: Upload the single file contained within the zip file to the root WHMCS directory
Download Link: http://www.whmcs.com/download/506/ticket-attachments-download-52

==Version 5.1.14==

'''Case 3663 - Client Area Currency Switching Problem'''
Full Details: http://forum.whmcs.com/showthread.php?81910
Steps to Apply: Upload the single file contained within the zip file to the /includes/ folder
Download Link: http://www.whmcs.com/download/502/currency-switching-hotfix-51

==Version 5.1.13==

'''Case 3471 - Ticket Attachment Downloads Fail in First Ticket Message (Does not affect replies)'''
Full Details: http://forum.whmcs.com/showthread.php?80718&p=344703#post344703
Steps to Apply: Upload the single file contained within the zip file to the root WHMCS directory
Download Link: http://www.whmcs.com/download/510/ticket-attachments-download-51

==Version Independent==

'''Case 3706 - Google Graphs API Object Error'''
Full Details: http://forum.whmcs.com/showthread.php?82419
Steps to Apply: Upload the single file contained within the zip file to the /includes/ folder
Download Link: http://www.whmcs.com/download/526/google-graphs-api-hotfix

HotFixes

2018-11-14T16:35:00Z

NickH:

Hot-Fix patch files are made available to address specific issues in releases. Please be sure to only apply patches that are valid for the version of WHMCS you have installed. Instructions to apply the fix may vary from case to case. Please read in full.

<div class="docs-alert-info">
<span class="title">Looking for Version 7?</span><br />
Hotfixes for version 7.0 and above are located here: [https://whmcs.community/files/categories/]
</div>

==Version 6.3.0==

'''CORE-9907 - Prevent fatal error on domain renewal'''
Full Details: http://forum.whmcs.com/showthread.php?112798
Steps to Apply: Upload the single file contained within the zip folder to the includes directory
Download Link: http://www.whmcs.com/download/842/prevent-fatal-error-on-domain-renewal

==Version 5.3.12==

'''CORE-8348 - Prevent Email Reopening rendering incorrectly in General Settings when enabled'''
Full Details: http://forum.whmcs.com/showthread.php?98506
Steps to Apply: Upload the single file contained within the zip folder to the admin directory
Download Link: http://www.whmcs.com/download/694/render-prevent-email-reopening-correctly

'''CORE-8351 - Domain renewal email template days until nextdue merge field always zero'''
Full Details: http://forum.whmcs.com/showthread.php?98503
Steps to Apply: Upload the single file contained within the zip folder to the includes directory
Download Link: http://www.whmcs.com/download/690/domain-days-until-nextdue

==Version 5.3.10==

'''Case 5197 - Can't access admin area in Windows environments'''
Full Details: http://forum.whmcs.com/showthread.php?93382
Steps to Apply: Upload the single file contained within the zip folder to the root directory
Download Link: http://www.whmcs.com/download/666/windows-admin-directory-fix

==Version 5.3.9==

'''Case 5077 - Two-Factor Auth redirecting to Admin Login for 5.3.9'''
Full Details: http://forum.whmcs.com/showthread.php?92550
Steps to Apply: Upload the single file contained within the zip folder to the admin directory
Download Link: http://www.whmcs.com/download/650/admin-two-factor-first-login-fix

==Version 5.3.6==

'''Case 4339 - Email CSS Styling not applying'''
Steps to Apply: Upload the single file contained within the zip folder to /includes/classes/WHMCS/
Download Link: http://www.whmcs.com/download/610/email-css-styling-fix

==Version 5.3.4==

'''Case 4116 - Doman Registration Fix'''
Steps to Apply: Upload the files as set out within the zip folder to your root WHMCS directory
Download Link: http://www.whmcs.com/download/582/domains-reg-fix

==Version 5.3.3==

'''Case 4061 - WorldPay Callback Fix'''
Steps to Apply: Upload the single file contained within the zip file to the /modules/gateways/callback/ folder
Download Link: http://www.whmcs.com/download/566/worldpay-callback-fix

'''Case 4016 - Gateway Parameters Fix'''
Full Details: http://forum.whmcs.com/showthread.php?85218
Steps to Apply: Upload the single file contained within the zip file to the /includes/classes/WHMCS/ folder
Download Link: http://www.whmcs.com/download/562/gateway-params-fix

==Version 5.2.13==

'''Case 3663 - Client Area Currency Switching Problem'''
Full Details: http://forum.whmcs.com/showthread.php?81910
Steps to Apply: Upload the single file contained within the zip file to the /includes/ folder
Download Link: http://www.whmcs.com/download/490/currency-switching-hotfix-52

'''Case 3671 - Insert Predefined Reply in Admin Open Ticket not working'''
Full Details: http://forum.whmcs.com/showthread.php?81990
Steps to Apply: Upload the single file contained within the zip file to the /admin/ folder
Download Link: http://www.whmcs.com/download/494/admin-new-ticket-predefined-52

'''Case 3672 - Add Predefined Product in Quotes not working'''
Full Details: Clicking the Add a Predefined Product link when creating or editing a quote leads to an invalid token error
Steps to Apply: Upload the single file contained within the zip file to the /admin/ folder
Download Link: http://www.whmcs.com/download/498/admin-quotes-predefined-product-52

==Version 5.2.12==

'''Case 3471 - Ticket Attachment Downloads Fail in First Ticket Message (Does not affect replies)'''
Full Details: http://forum.whmcs.com/showthread.php?80718&p=344703#post344703
Steps to Apply: Upload the single file contained within the zip file to the root WHMCS directory
Download Link: http://www.whmcs.com/download/506/ticket-attachments-download-52

==Version 5.1.14==

'''Case 3663 - Client Area Currency Switching Problem'''
Full Details: http://forum.whmcs.com/showthread.php?81910
Steps to Apply: Upload the single file contained within the zip file to the /includes/ folder
Download Link: http://www.whmcs.com/download/502/currency-switching-hotfix-51

==Version 5.1.13==

'''Case 3471 - Ticket Attachment Downloads Fail in First Ticket Message (Does not affect replies)'''
Full Details: http://forum.whmcs.com/showthread.php?80718&p=344703#post344703
Steps to Apply: Upload the single file contained within the zip file to the root WHMCS directory
Download Link: http://www.whmcs.com/download/510/ticket-attachments-download-51

==Version Independent==

'''Case 3706 - Google Graphs API Object Error'''
Full Details: http://forum.whmcs.com/showthread.php?82419
Steps to Apply: Upload the single file contained within the zip file to the /includes/ folder
Download Link: http://www.whmcs.com/download/526/google-graphs-api-hotfix

Merchant Partners

2018-11-06T09:26:03Z

NickH:

==Overview==
Merchant Partners is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: http://www.merchantpartners.com/

==Setup==
To activate the Merchant Partners module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose Merchant Partners from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
}}

{{modules}}

Kuveytturk

2018-11-06T09:25:23Z

NickH:

==Overview==
Kuveytturk is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.kuveytturk.com.tr/

==Setup==
To activate the Kuveytturk module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose Kuveytturk from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| recurring = yes
| onetime = yes
}}

{{modules}}

IP.Pay

2018-11-06T09:24:21Z

NickH:

==Overview==
IP.Pay is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.ippay.com/

==Setup==
To activate the IPPay module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose IPPay from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| recurring = yes
| onetime = yes
| refunds = yes
}}

{{modules}}

IMSP

2018-11-06T09:21:31Z

NickH:

==Overview==
IMSP is a credit card merchant gateway that is integrated with WHMCS.

==Setup==
To activate the IMSP module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose IMSP from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| 3dsecure = yes
}}

{{modules}}

FastHosts

2018-11-06T09:20:13Z

NickH:

==Overview==
FastHosts is a credit card merchant gateway that is integrated with WHMCS.

==Setup==
To activate the FastHosts module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose FastHosts from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
}}

{{modules}}

Template:Modules

2018-11-06T09:18:34Z

NickH:

<includeonly><div style="width:100%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;padding:10px;margin-right:auto;margin-left:auto;">
'''Server Modules'''<br />
[[CPanel/WHM|cPanel/WHM]] - [[DirectAdmin]] - [[Plesk]] - [[Helm 3]] - [[Helm 4]] - [[Ensim]] - [[InterWorx]] - [[WebsitePanel]] - [[Cloudmin]] - [[VePortal]]<br />
[[Lxadmin]] - [[Virtualmin Pro]] - [[XPanel]] - [[HyperVM]] - [[FluidVM]] - [[SolusVM]] - [[Cloudmin]] - [[WHMSonic]] - [[VPS.Net]]<br />
[[CentovaCast]] - [[SCPanel]] - [[MediaCP]] - [[GameCP]] - [[TCAdmin]] - [[Reseller Central]] - [[Auto Release]] - [[Heart Internet]]<br />
<br />
'''Registrar Modules'''<br />
[[Enom]] - [[ResellerClub]] - [[Nominet]] - [[OpenSRS]] - [[ResellOne]] - [[OnlineNIC]] - [[PlanetDomain]] - [[Affordable Domains]]<br />
[[TPP Wholesale|TPP Wholesale]] - [[TPPInternet]] - [[Stargate]] - [[Namecheap]] - [[NetEarthOne]] - [[Bizcn]] - [[InternetBS]] - [[GMO Internet]]<br />
[[12Register]] - [[Registercom]] - [[DotDNS]] - [[WebNIC]] - [[Dot.TK]] - [[HexoNet]] - [[Realtime Register]] - [[Registereu]]<br />
[[RRPProxy]] - [[ResellerCamp]] - [[TransIP]] - [[Heart Internet]] - [[IPMirror]] - [[NetRegistry]] - [[OVH]] - [[VentraIP Wholesale]]<br />
[[Email]] - [[101Domain]]<br />
<br />
'''Fraud Modules'''<br />
[[MaxMind]] - [[VariLogiX FraudCall]] - [[Telesign]]<br />
<br />
'''Gateway Modules'''<br />
[[2CheckOut]] - [[AsiaPay]] - [[Authorize.net#Echeck_Module|Auth.net Echeck]] - [[Authorize.net]] - [[Authorize.net CIM]] - [[Bank Transfer]]<br />
[[BluePay]] - [[BluePay#BluePay_e-Check|BluePay Echeck]] - [[BluePay#BluePay_Remote|BluePay Remote]] - [[Boleto]] - [[CamTech]] - [[CashU]] - [[CC Avenue]] - [[ChronoPay]]<br />
[[Cyberbit]] - [[Direct Debit]] - [[EMatters]] - [[E-Path]] - [[EProcessingNetwork|eProcessingNetwork]]<br />
[[EWAY_Tokens|eWAY Tokens]] - [[F2B]] - [[FastHosts]] - [[Finansbank]] - [[GarantiBank]] - [[Gate2Shop]] - [[LinkPoint]]<br />
[[IMSP]] - [[Inpay]] - [[IP.Pay]] - [[Kuveytturk]] - [[Modulo Moip]] - [[Mail In Payment]]<br />
[[Merchant Partners]] - [[Merchant Warrior]] - [[IDEALMollie]] - [[Moneris]] - [[Moneris#Moneris_Vault|Moneris Vault]]<br />
[[Skrill 1-Tap]] - [[SlimPay]] - [[NaviGate]] - [[NETbilling]] - [[Netregistry Pay]] - [[NoChex]] - [[NTPNow]]<br />
[[Offline Credit Card]] - [[Optimal Payments]] - [[PagSeguro]] - [[Payflow Pro]] - [[Pay Junction]]<br />
[[Paymate AU and NZ]] - [[Payment Express]] - [[Paymex]] - [[PayPal]] - [[PayPal Express Checkout]] - [[PayPal Payments Pro]]<br />
[[PayPoint|PayPoint.net (SecPay)]] - [[Payson]] - [[Payza]] - [[Planet Authorize]] - [[SagePay]] - [[ProtX VSP Form]] - [[PSIGate]]<br />
[[Quantum Gateway]] - [[Quantum Vault]] - [[SagePay]] - [[SagePay#SagePay_Tokens|SagePay Tokens]] - [[SecPay]] - [[SecurePay]] - [[SecurePay AU]]<br />
[[Secure Trading]] - [[TrustCommerce]] - [[USA ePay]] - [[WorldPay]] - [[WorldPay Invisible]]

</div></includeonly><noinclude>
Add <nowiki>{{modules}}</nowiki> for a footer to your module pages, produces:
{{modules}}
</noinclude>

EProcessingNetwork

2018-11-06T09:10:14Z

NickH:

==Overview==
eProcessingNetwork is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.eprocessingnetwork.com/

==Setup==
To activate the eProcessingNetwork module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose eProcessingNetwork from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
}}

{{modules}}

EMatters

2018-11-06T09:08:40Z

NickH:

==Overview==
eMatters is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.ematters.com.au/

==Setup==
To activate the eMatters module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose eMatters from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
}}

{{modules}}

Cyberbit

2018-11-06T09:07:23Z

NickH:

==Overview==
Cyberbit is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.merchantplus.com/galaxy/brands/cyberbit/

==Setup==
To activate the Cyberbit module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose Cyberbit from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = token
| onetime = yes
| recurring = yes
}}

{{modules}}

AsiaPay

2018-11-06T09:05:58Z

NickH:

==Overview==

AsiaPay is an online payment service and solutions provider in Asia that provides electronic payment gateway solutions. AsiaPay offers multi-currency, multi-lingual, multi-card, and multi-channel functionality together with advanced fraud detection and management solutions. Headquartered in Hong Kong, AsiaPay supports 12 countries including Asia including: Hong Kong, China, India, Indonesia, Malaysia, Singapore, Philippines, Taiwan, Thailand and Vietnam and is rapidly expanding to new Asia Pacific markets.

For more information, please see http://www.asiapay.com

==Setup==
To activate the AsiaPay module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose AsiaPay from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| onetime = yes
| recurring = yes
}}

==Secure Hash Key==

We recommend using the Secure Hash Key to protect against unauthorized callbacks.

<div class="docs-alert-info">'''UPDATE:''' As of Version 6.0, configuring a Secure Hash Key is required. No callbacks will be accepted or processed without it.</div>

To setup a Secure Hash Key within your AsiaPay account, you must contact the PayDollar Service Department (service@paydollar.com) to request the Secure Hash function be enabled for your merchant account. Once enabled, you can retrieve the hash from within the Merchant Administration Interface by navigating to '''Profile > Payment Information'''.

Once you have obtained your Secure Hash, enter it into the "Secure Hash Key" field within the WHMCS Payment Gateway Configuration area for the AsiaPay module.

The instructions above are correct as of the time of writing (June 2015).

{{modules}}

Authorize.net

2018-11-06T09:05:16Z

NickH:

==Overview==
Authorize.net is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.authorize.net/

==Setup==
To activate the Authorize.net module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose Authorize.net from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refunds = yes
}}

==Customer Information Manager (CIM)==

{{gateways
| type = token
| recurring = yes
| refunds = yes
| level = 3
| updatecc = yes
| deletecc = yes
}}

The Authorize.net Customer Information Manager (CIM) system allows you to store customers' sensitive payment information on Authorize.net's secure servers, simplifying your compliance with the Payment Card Industry Data Security Standard (PCI DSS).

This works by only storing the full card number on Authorize's system, and not locally in your WHMCS database, and thus even if you were to be compromised, the encrypted full card numbers are not there for any potential hackers to access and potentially use.

For more information please refer to [[Authorize.net CIM]].

==Echeck Module==

{{gateways
| onetime = yes
| recurring = yes
| level = 3
}}

The Echeck module for Auth.net allows for payments to be processed directly from a bank account. The details entered are stored against the client profile and used for automated recurring billing on future invoices.

To setup, simply activate the "Authorize.net Echeck" option in '''Setup > Payment Gateways''' and enter your Auth.net Login ID & Transaction Key along with a custom name for the module where requested. And then that new payment method option will now show in the order process and on invoices for users to choose and make payment with should they choose. No further setup is required.

{{modules}}

BluePay

2018-11-06T09:04:30Z

NickH:

==Overview==
BluePay is a credit card merchant gateway that is integrated with WHMCS. You can find more information at: https://www.bluepay.com/

==Setup==
To activate the BluePay module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose BluePay from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refunds = yes
}}

==BluePay e-Check==

{{gateways
| type = token
| recurring = yes
| level = 3
}}

==BluePay Remote==
{{gateways
| type = token
| recurring = yes
| level = 3
| updatecc = yes
}}

{{modules}}

CamTech

2018-11-06T09:03:08Z

NickH:

==Overview==
CamTech is a credit card merchant gateway that is integrated with WHMCS.

==Setup==
To activate the CamTech module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose CamTech from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
}}

{{modules}}

BluePay

2018-11-06T09:00:40Z

NickH:

==Setup==
To activate the BluePay module in WHMCS, navigate to Setup > Payments > Payment Gateways and choose BluePay from the "All Payment Gateways" tab.

Once activated, you can then customize the name to something more friendly such as "Credit Card". To complete setup, you would then enter your credentials in the appropriate boxes.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refunds = yes
}}

==BluePay e-Check==

{{gateways
| type = token
| recurring = yes
| level = 3
}}

==BluePay Remote==
{{gateways
| type = token
| recurring = yes
| level = 3
| updatecc = yes
}}

{{modules}}

Quantum Gateway

2018-11-06T03:17:01Z

NickH:

==Overview==

Quantum Gateway is a merchant gateway solution that supports 3D Secure for Visa & MasterCard Transactions in WHMCS.

If you don't yet have an account, visit [http://www.whmcs.com/partners/quantum-gateway/ www.whmcs.com/partners/quantum-gateway/] for more information.

==Setup==

*You must use your Quantum gateway login id as your username
*If you don't have your '''RestrictKey''', you can easily generate it by login into your Quantum Gateway merchant center and going to the Processing settings area. Scroll down until you see the "RestrictKey" area. Click the generate button, check the "Use restriction key" box, and finally click the UPDATE button. That is your new restriction key (Transaction Key).
{{gateways
| type = cc
| onetime = yes
| recurring = yes
| 3dsecure = yes
| refunds = yes
}}

==MD5 Hash Verification==

The MD5 Hash in the Quantum Gateway module is used to prevent forged callback requests. To set this up in your Quantum Gateway Account:

* Navigate to ''Configuration > Processing Settings''
* Scroll down to the '''MD5-Hash''' heading
* Enter a secret key value of your own choosing in the '''Hash Value''' field.
* Set the '''Include Response In Hash''' value to "No"
* Then enter the same value into your WHMCS installation Quantum Gateway config in '''Setup > Payments > Payment Gateways'''.

==Quantum Vault Service==

{{gateways
| type = token
| onetime = yes
| recurring = yes
| refunds = yes
| level = 3
| updatecc = yes
| deletecc = yes
}}

The Vault Solution from Quantum Gateway enables you to accept credit cards through your site while completely avoiding the hassles of PCI compliance and here at WHMCS we were one of the first to offer this new service to Quantum users.

For more information visit the [[Quantum Vault]] page

===How does it work?===

#The customer leaves your site to perform 3D Secure authentication (exactly the same as they already do now) but the difference is they enter their card details once they've left your site aswell so that the card details never pass through your site
#The customer can still edit their card held on file at any time from the client area
#WHMCS can still request the card is rebilled whenever needed meaning fully automated recurring billing can continue as before and manual captures at any time are also still possible - it's just like you have the card details stored locally

===Why does it avoid PCI compliance?===

#No cardholder data ever touches or passes through your Network, Server or WHMCS System
#No cardholder data is ever retained or stored on your Network, Server or WHMCS system

===Configuration/Setup===

You will find the module in the '''Setup > Payment Gateways''' area listed as Quantum Vault which you can activate and configure in the same way as the regular module.

For existing Quantum Gateway users, there is also a '''vault migration script''' available to transfer all your existing clients card details over to the vault automatically and remove them from your local database. It can be downloaded from https://www.whmcs.com/download/117/quantum-vault-migration-utility

Inside your Quantum Gateway account, you will need to configure and API Username, Key and Vault Key to use the Vault API, and in the Inline Frame API settings where it asks for various urls, you should leave all of those fields blank.

Contrary to what you might think, you should leave the "Disable Credit Card Storage" setting unticked in '''Setup > General Settings > Security''' as that will disable entry by a client.

{{modules}}

PSIGate

2018-11-06T03:16:09Z

NickH:

==Setup==
To activate the PSIGate module in WHMCS, navigate to '''Setup > Payments > Payment Gateways''' and choose PSIGate from the Available Gateways dropdown.

Once activated, you can then customise the name to something more friendly such as "Credit Card" and enter the Store ID
Pass Phrase corresponding to your PSIGate account.

In order to use this payment gateway module some firewall adjustments may be necessary; port 27989 for test mode, and 27934 for live mode must be open for incoming and outgoing connections.
{{gateways
| type = cc
| onetime = yes
| recurring = yes
| refunds = yes
}}

{{modules}}

AsiaPay

2018-11-06T03:04:01Z

NickH: /* Overview */

==Overview==

AsiaPay is an online payment service and solutions provider in Asia that provides electronic payment gateway solutions. AsiaPay offers multi-currency, multi-lingual, multi-card, and multi-channel functionality together with advanced fraud detection and management solutions. Headquartered in Hong Kong, AsiaPay supports 12 countries including Asia including: Hong Kong, China, India, Indonesia, Malaysia, Singapore, Philippines, Taiwan, Thailand and Vietnam and is rapidly expanding to new Asia Pacific markets.

For more information, please see www.asiapay.com
{{gateways
| onetime = yes
| recurring = yes
}}

==Activating the Module==

To activate and configure the module, navigate to Setup > Payment Gateways and select "'''AsiaPay'''" from the list of available payment gateways provided in the dropdown. Then enter the details as requested.

==Secure Hash Key==

We recommend using the Secure Hash Key to protect against unauthorized callbacks.

<div class="docs-alert-info">'''UPDATE:''' As of Version 6.0, configuring a Secure Hash Key is required. No callbacks will be accepted or processed without it.</div>

To setup a Secure Hash Key within your AsiaPay account, you must contact the PayDollar Service Department (service@paydollar.com) to request the Secure Hash function be enabled for your merchant account. Once enabled, you can retrieve the hash from within the Merchant Administration Interface by navigating to '''Profile > Payment Information'''.

Once you have obtained your Secure Hash, enter it into the "Secure Hash Key" field within the WHMCS Payment Gateway Configuration area for the AsiaPay module.

The instructions above are correct as of the time of writing (June 2015).

{{modules}}

AsiaPay

2018-11-06T03:03:44Z

NickH:

==Overview==

AsiaPay is an online payment service and solutions provider in Asia that provides electronic payment gateway solutions. AsiaPay offers multi-currency, multi-lingual, multi-card, and multi-channel functionality together with advanced fraud detection and management solutions. Headquartered in Hong Kong, AsiaPay supports 12 countries including Asia including: Hong Kong, China, India, Indonesia, Malaysia, Singapore, Philippines, Taiwan, Thailand and Vietnam and is rapidly expanding to new Asia Pacific markets.

For more information, please see www.asiapay.com

{{gateways
| onetime = yes
| recurring = yes
}}

==Activating the Module==

To activate and configure the module, navigate to Setup > Payment Gateways and select "'''AsiaPay'''" from the list of available payment gateways provided in the dropdown. Then enter the details as requested.

==Secure Hash Key==

We recommend using the Secure Hash Key to protect against unauthorized callbacks.

<div class="docs-alert-info">'''UPDATE:''' As of Version 6.0, configuring a Secure Hash Key is required. No callbacks will be accepted or processed without it.</div>

To setup a Secure Hash Key within your AsiaPay account, you must contact the PayDollar Service Department (service@paydollar.com) to request the Secure Hash function be enabled for your merchant account. Once enabled, you can retrieve the hash from within the Merchant Administration Interface by navigating to '''Profile > Payment Information'''.

Once you have obtained your Secure Hash, enter it into the "Secure Hash Key" field within the WHMCS Payment Gateway Configuration area for the AsiaPay module.

The instructions above are correct as of the time of writing (June 2015).

{{modules}}

AsiaPay

2018-11-06T03:03:16Z

NickH:

{{gateways
| onetime = yes
| recurring = yes
}}

==Overview==

AsiaPay is an online payment service and solutions provider in Asia that provides electronic payment gateway solutions. AsiaPay offers multi-currency, multi-lingual, multi-card, and multi-channel functionality together with advanced fraud detection and management solutions. Headquartered in Hong Kong, AsiaPay supports 12 countries including Asia including: Hong Kong, China, India, Indonesia, Malaysia, Singapore, Philippines, Taiwan, Thailand and Vietnam and is rapidly expanding to new Asia Pacific markets.

For more information, please see www.asiapay.com

==Activating the Module==

To activate and configure the module, navigate to Setup > Payment Gateways and select "'''AsiaPay'''" from the list of available payment gateways provided in the dropdown. Then enter the details as requested.

==Secure Hash Key==

We recommend using the Secure Hash Key to protect against unauthorized callbacks.

<div class="docs-alert-info">'''UPDATE:''' As of Version 6.0, configuring a Secure Hash Key is required. No callbacks will be accepted or processed without it.</div>

To setup a Secure Hash Key within your AsiaPay account, you must contact the PayDollar Service Department (service@paydollar.com) to request the Secure Hash function be enabled for your merchant account. Once enabled, you can retrieve the hash from within the Merchant Administration Interface by navigating to '''Profile > Payment Information'''.

Once you have obtained your Secure Hash, enter it into the "Secure Hash Key" field within the WHMCS Payment Gateway Configuration area for the AsiaPay module.

The instructions above are correct as of the time of writing (June 2015).

{{modules}}

Live Chat Addon

2018-09-25T13:29:45Z

NickH: /* Integration Outside of WHMCS */

https://www.whmcs.com/images/available_on_marketplace.png

For more information and to order, please visit https://marketplace.whmcs.com/product/34

==Download==

To download the latest version of the live chat add-on, visit https://www.whmcs.com/members/ and login using your registered email address and password.

===If your WHMCS licence is purchased directly===
[[File:livechatdownload1.png|thumb|Live Chat Direct Download]]

Once logged in, navigate to '''Services > All Products & Services''', select your main WHMCS licence (Leased- or Owned-) and the download will be available from the Information tab within that licence.

===If your WHMCS licence is purchased from a reseller===
[[File:livechatdownload2.png|thumb|Live Chat Reseller Download]]
Once logged in, navigate to '''Services > All Products & Services''', select your live chat purchase, and the download will be available from the Downloads tab within that product.

==Installation==

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=fcCKomdCe4Y&hd=1|Watch Video Tutorial]]

To install, perform the steps below.

#Unzip the zip file download.
#Upload the contents of the '''‘upload_me’''' directory to your WHMCS installation root directory.
#Ensure the ''/modules/livehelp/templates_c/'' directory is writeable
#Visit the url below in a browser to complete the installation: ''www.yourdomain.com/whmcs/modules/livehelp/install''

<div class="docs-alert-info">After the installation has been completed, delete the installation directory located at /modules/livehelp/install/</div>

<div class="docs-alert-warning"><strong><i class="fa fa-info-circle"></i>  License Update</strong><br />If you recently purchased the Live Chat Add-on prior to installation, you may need to force a license update for your WHMCS installation to recognise the purchase. If you receive a license error or have trouble logging in after installation, login to your WHMCS Admin Area, navigate to ''Help > License Information'' and then click the '''Force License Update''' button. Then try logging in again.</div>

To login to Live Chat, visit www.yourdomain.com/whmcs/modules/livehelp/admin

You will be able to login using the same username and password as you use for the WHMCS admin area.

===Install GeoIP Location Data===

Install the optional MaxMind GeoIP data which allows you to see where visitors are located (recommended).

The MaxMind GeoLite City (free) and MaxMind GeoIP City (paid with higher accuracy) databases are supported. These databases are not included with the Live Help downloads (due to the size of the database) so you will need to download the latest database from the MaxMind web site. The following instructions are for installing the database:

# Download the MaxMind GeoLite City database at GeoLite City (Approx. 18MB): http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
# Unzip the file on your local PC, you can use a free tool like 7zip for unzipping the GeoLiteCity.dat.gz file.
# Upload the GeoLiteCity.dat file to the /modules/livehelp/plugins/maxmind/ directory. The file is approximately 30MB so this may take some time.
# The GeoLite database should be located at /modules/livehelp/plugins/maxmind/GeoLiteCity.dat when finished uploading

The MaxMind GeoLite database is updated each month (normally on the 1st of each month) so you can replace this file every month if you wish to use the most accurate location data. Further details on the MaxMind GeoLite City database is available at http://www.maxmind.com/app/geolitecity

==Upgrading==

If you have an earlier version of the Live Chat Add-on installed follow the steps below to upgrade to the latest version.

<div class="docs-alert-success"><strong>How to find the Latest Version</strong><br>To download the latest version, visit https://www.whmcs.com/members/ and login using your registered email address and password. Once logged in, navigate to ''Services > All Products & Services'', select your live chat purchase, and the download will then be available from the Downloads tab within that product.</div>

#Unzip the zip file download.
#Upload the contents of the '''‘upload_me’''' directory to your WHMCS installation root directory.
#Login to the Live Chat Add-on web based administration panel to complete the upgrade process: ''www.yourdomain.com/whmcs/modules/livehelp/admin''

<div class="docs-alert-info">After the upgrade has been completed, delete the installation directory located at /modules/livehelp/install/</div>

==Integration Outside of WHMCS==

To integrate the visitor tracking and live help buttons to pages outside of your WHMCS installation (for example your main website pages), follow the steps below.

<div class="docs-alert-warning">'''Do Not Attempt''' to add this code to WHMCS templates - it is handled automatically as described above</div>

'''Step 1''' The following lines should be added on each page after your <title> tag and just before your </head> tag (this should be added once per page):

<source lang="js">
<script type="text/javascript">

</script>
</source>

You need to customise the URL specified in the '''Chatstack.server''' parameter in the above code with the domain and path to your WHMCS installations modules directory.

''Note: For this code to properly run on your website, jQuery must be called on your website prior to the code.''

'''Step 2''' The following lines can be optionally added to the page anywhere you wish to display the Live Chat Operator status and end user chat initiation button.

<source lang="js">
<a href="#" class="LiveHelpButton"><img src="http://www.example.com/whmcs/modules/livehelp/status.php" id="LiveHelpStatus" name="LiveHelpStatus" class="LiveHelpStatus" border="0" alt="Live Help" /></a>
</source>

Alternatively if you would prefer a static text link for chat initiation, that can also be achieved as follows:

<source lang="php">
<a href="#" class="LiveHelpButton">Chat With Us Live</a>
</source>

==Web Admin Interface==

The Live Help web-based administration interface can be accessed at

http://www.yourdomain.com/whmcs/modules/livehelp/admin/

==Desktop Applications==

Downloadable clients are available for Windows, Mac and Linux.

Mobile Apps are also available for iPhone and Android.

In most cases, these apps are available through the respective App Store's for these devices. The Windows app is available via the download link below.

===Windows===

====Requirements====

The requirements for the Windows App are as follows:

*Windows 7 / Vista / XP SP 2
*Internet Explorer 7 or above
*.NET Framework 3.5 SP1 or above - [http://www.microsoft.com/downloads/details.aspx?FamilyId=333325FD-AE52-4E35-B531-508D977D32A6 Download]
*Internet Connection

====Installation====

You can download the latest version of the Windows Desktop Application at any time from https://secure.stardevelop.com/downloads/download-latest.php and then follow the automated installer process to install on your computer.

===First Use===

When you first attempt to sign-in to the Live Help Messenger application you will be presented with the following window.

<center>http://livehelp.stardevelop.com/documentation/images/signin.jpg</center>

You will need to enter your Account, Username and Password to access the Live Help system, these are described below.

* '''Account or Server:''' If Live Help is installed at http://www.yourdomain.com/whmcs/modules/livehelp/ then your account or server would be entered as www.yourdomain.com/whmcs/modules/
* '''Username / Password:''' The username and password are the same as those used to login to the main WHMCS administration area.
* '''Enable Secure Sign In:''' You can login to the Live Help administration via. SSL if your installation is accessible at https://www.yourdomain.com
* '''Sign In Automatically:''' This option will automatically sign-in a given account the next time the Live Help Messenger application is opened.

Once you have signed into the Live Help Messenger application you will be able to quickly sign-in again using the previous account.

<center>http://livehelp.stardevelop.com/documentation/images/previouslogin.jpg</center>

The previous sign-in area only requires you to enter the password of the account.

For further information on the Windows app and its usage, please refer to the ChatStack website at https://www.chatstack.com/kb/category/apps/

==Uninstallation==

To remove the Live Chat Addon from your installation, perform these steps:

# Delete the ''/modules/livehelp/'' directory
# Delete the ''/includes/hooks/livehelp.php'' file

You may also optionally remove/drop the database tables that begin ''mod_livehelp*'' however this step is not required.

==Further Reading==

Chaststack provides additional documentation covering how to use the live help software at:
http://www.chatstack.com/kb/

==Common Troubleshooting Tips==

===Chat button non-functional / Blank live chat window===
If clicking the chat button results in nothing happening or the live chat popup window is showing a blank chat window, first ensure that the /modules/livehelp/templates_c/ directory both exists and is writeable. We recommend that you try the following permissions in this order 755, 775 and 777.

===The requested content cannot be loaded. Please try again later.===
Upon clicking the "Chat Now" link, this message appears in the centre of the screen. This behaviour indicates that the templates cache cannot be created.

To resolve ensure that the /modules/livehelp/templates_c/ directory both exists and is writeable. We recommend that you try the following permissions in this order 755, 775 and 777.

===License Invalid / Unable to login===
If when first opening the live chat admin interface or connecting via the Windows Desktop App you get a "License Invalid" warning message, this indicates that your WHMCS installation has not yet updated to recognise your purchase of the addon. Your WHMCS install only calls home to validate your license with us periodically and so if you have only recently purchased the addon, you may need to force a local key update to have it take effect. To do that, navigate to '''Help > License Information''' and then click the '''Force License Update''' button. Then try logging in again.

If it continues after that, please get in touch with us for assistance.

===Incorrect Server/Host===

Receiving this error message in one of the Desktop or Mobile clients indicates that the Live Help installation cannot be found at the given URL. Double check the URL you've entered. If Live Help is installed at http://www.yourdomain.com/whmcs/modules/livehelp/ then you should enter it in the format www.yourdomain.com/whmcs/modules/

==About==

The WHMCS Live Chat & Visitor Tracking Add-on is developed in partnership with Chatstack bringing a feature rich and powerful integrated chat solution to WHMCS users. Featuring benefits including automatic client detection, loginshare, shared access to WHMCS predefined responses, integrated logging of chat transcripts and more.

Payment Gateways

2018-09-11T06:39:25Z

NickH: /* Third Party Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[EWAY Rapid 3.1]] || [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]
|-
| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[Stripe]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || ||
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[Authorize.net#Echeck_Module|Authorize.net Echeck]]
| width="33%" | [[Bank Transfer]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CashU]]
|-
| [[CC Avenue]] || [[ChronoPay]] || [[F2B|Cobrança - F2b]]
|-
| [[Direct Debit]] || [[e-Path]] || [[Forte]]
|-
| [[Gate2Shop]] || [[IDEALMollie|iDeal via Mollie]] || [[inpay]]
|-
| [[Mail In Payment]] || [[Modulo Moip]] || [[NoChex]]
|-
| [[PagSeguro]] || [[Paymate AU and NZ]] || [[Payment Express]]
|-
| [[Paymex]] || [[PayPal]] || [[PayPal Express Checkout]]
|-
| [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]] || [[Payza]]
|-
| [[Planet Authorize]] || [[Skrill 1-Tap]] || [[SlimPay]]
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:38:02Z

NickH: /* Third Party Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[EWAY Rapid 3.1]] || [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]
|-
| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[Stripe]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || ||
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[Authorize.net#Echeck_Module|Authorize.net Echeck]]
| width="33%" | [[Bank Transfer]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CashU]]
|-
| [[CC Avenue]] || [[ChronoPay]] || [[F2B|Cobrança - F2b]]
|-
| [[Direct Debit]] || [[e-Path]] || [[Forte]]
|-
| [[Gate2Shop]] || [[IDEALMollie|iDeal via Mollie]] || [[inpay]]
|-
| [[Mail In Payment]] || [[Modulo Moip]] || [[NoChex]]
|-
| [[PagSeguro]] || [[Paymate AU and NZ]] || [[Payment Express]]
|-
| [[Paymex]] || [[PayPal]] || [[PayPal Express Checkout]]
|-
| [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]] || [[Payza]]
|-
| [[Planet Authorize]] || [[Skrill 1-Tap]] || [[SlimPay]]
|-
| [[Finansbank|Turkish Finansbank]] || [[Garanti Bank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:37:10Z

NickH: /* Third Party Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[EWAY Rapid 3.1]] || [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]
|-
| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[Stripe]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || ||
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[Authorize.net#Echeck_Module|Authorize.net Echeck]]
| width="33%" | [[Bank Transfer]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CashU]]
|-
| [[CC Avenue]] || [[ChronoPay]] || [[F2B|Cobrança - F2b]]
|-
| [[Direct Debit]] || [[e-Path]] || [[Forte]]
|-
| [[Gate2Shop]] || [[IDEALMollie|iDeal via Mollie]] || [[inpay]]
|-
| [[Mail In Payment]] || [[Modulo Moip]] || [[NoChex]]
|-
| [[PagSeguro]] || [[Paymate AU and NZ]] || [[Payment Express]]
|-
| [[Paymex]] || [[PayPal]] || [[PayPal Express Checkout]]
|-
| [[PayPoint.net|PayPoint.net (SecPay)]] || [[Payson]] || [[Payza]]
|-
| [[Planet Authorize]] || [[Skrill 1-Tap]] || [[SlimPay]]
|-
| [[Finansbank|Turkish Finansbank]] || [[Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:35:52Z

NickH: /* Third Party Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[EWAY Rapid 3.1]] || [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]
|-
| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[Stripe]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || ||
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[Authorize.net#Echeck_Module|Authorize.net Echeck]]
| width="33%" | [[Bank Transfer]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CashU]]
|-
| [[CC Avenue]] || [[ChronoPay]] || [[F2B|Cobrança - F2b]]
|-
| [[Direct Debit]] || [[e-Path]] || [[Forte]]
|-
| [[Gate2Shop]] || [[IDEALMollie|iDeal via Mollie]] || [[inpay]]
|-
| [[Mail In Payment]] || [[Modulo Moip]] || [[NoChex]]
|-
| [[PagSeguro]] || [[Paymate AU and NZ]] || [[Payment Express]]
|-
| [[Paymex]] || [[PayPal]] || [[PayPal Express Checkout]]
|-
| [[PayPoint.net (SecPay)]] || [[Payson]] || [[Payza]]
|-
| [[PlanetAuthorize]] || [[Skrill 1-Tap]] || [[SlimPay]]
|-
| [[Turkish Finansbank]] || [[Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:23:15Z

NickH: /* Tokenisation Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[EWAY Rapid 3.1]] || [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]
|-
| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[Stripe]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || ||
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[2CheckOut]]
| width="33%" |
| width="33%" |
|-
| [[Authorize.net#Echeck_Module|Authorize.net Echeck]] || [[Bank Transfer]] ||
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CC Avenue]]
|-
| [[CashU]] || [[ChronoPay]] || [[Direct Debit]]
|-
| [[F2B|Cobrança - F2b]] || [[Forte]] ||
|-
| [[e-Path]] || || [[Gate2Shop]]
|-
| || || [[iDEALMollie|iDEAL via Mollie]]
|-
| [[inpay]] || [[Mail In Payment]] || [[Modulo Moip]]
|-
| || [[Skrill_1-Tap]] || [[SlimPay]]
|-
| [[NoChex]] || [[PagSeguro]] || [[PayPal]]
|-
| [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]]
|-
| [[Paymate_AU_and_NZ]] || [[Payment Express]] || [[Paymex]]
|-
| [[Payza]] || [[Planet Authorize]] ||
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:19:31Z

NickH: /* Merchant Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||
|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]] || [[Quantum Vault]]
|-
| [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || [[EWAY Rapid 3.1]]
|-
| [[Stripe]]
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[2CheckOut]]
| width="33%" |
| width="33%" |
|-
| [[Authorize.net#Echeck_Module|Authorize.net Echeck]] || [[Bank Transfer]] ||
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CC Avenue]]
|-
| [[CashU]] || [[ChronoPay]] || [[Direct Debit]]
|-
| [[F2B|Cobrança - F2b]] || [[Forte]] ||
|-
| [[e-Path]] || || [[Gate2Shop]]
|-
| || || [[iDEALMollie|iDEAL via Mollie]]
|-
| [[inpay]] || [[Mail In Payment]] || [[Modulo Moip]]
|-
| || [[Skrill_1-Tap]] || [[SlimPay]]
|-
| [[NoChex]] || [[PagSeguro]] || [[PayPal]]
|-
| [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]]
|-
| [[Paymate_AU_and_NZ]] || [[Payment Express]] || [[Paymex]]
|-
| [[Payza]] || [[Planet Authorize]] ||
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:19:04Z

NickH: /* Merchant Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

{| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
|-
| width="33%" | [[AsiaPay]]
| width="33%" | [[Authorize.net]]
| width="33%" | [[BluePay]]
|-
| [[CamTech]] || [[Cyberbit]] || [[eMatters]]
|-
| [[eProcessingNetwork]] || [[FastHosts]] || [[IMSP]]
|-
| [[IP.Pay]] || [[Kuveytturk]] || [[LinkPoint]]
|-
| [[Merchant Partners]] || [[Moneris]] || [[Merchant Warrior]]
|-
| [[NaviGate]] || [[NETbilling]] || [[Netregistry Pay]]
|-
| [[NTPNow]] || [[Offline Credit Card]] || [[Optimal Payments]]
|-
| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
|-
| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
|-
| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
|-
| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
|-
| [[WorldPay Invisible]] || ||

|}

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]] || [[Quantum Vault]]
|-
| [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || [[EWAY Rapid 3.1]]
|-
| [[Stripe]]
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[2CheckOut]]
| width="33%" |
| width="33%" |
|-
| [[Authorize.net#Echeck_Module|Authorize.net Echeck]] || [[Bank Transfer]] ||
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CC Avenue]]
|-
| [[CashU]] || [[ChronoPay]] || [[Direct Debit]]
|-
| [[F2B|Cobrança - F2b]] || [[Forte]] ||
|-
| [[e-Path]] || || [[Gate2Shop]]
|-
| || || [[iDEALMollie|iDEAL via Mollie]]
|-
| [[inpay]] || [[Mail In Payment]] || [[Modulo Moip]]
|-
| || [[Skrill_1-Tap]] || [[SlimPay]]
|-
| [[NoChex]] || [[PagSeguro]] || [[PayPal]]
|-
| [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]]
|-
| [[Paymate_AU_and_NZ]] || [[Payment Express]] || [[Paymex]]
|-
| [[Payza]] || [[Planet Authorize]] ||
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:11:50Z

NickH: /* Third Party Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

<div class="row">
<div class="col-sm-4">

[[AsiaPay]]<br />
[[Authorize.net]]<br />
[[BluePay]]<br />
[[CamTech]]<br />
[[Cyberbit]]<br />
[[eMatters]]<br />
[[eProcessingNetwork]]<br />
[[FastHosts]]<br />
[[IMSP]]<br />
[[IP.Pay]]<br />
[[Kuveytturk|Kuveytturk Bank]]<br />

</div>
<div class="col-sm-4">

[[LinkPoint]]<br />
[[Merchant Partners]]<br />
[[Moneris]]<br />
[[Merchant Warrior]]<br />
[[NaviGate]]<br />
[[NETbilling]]<br />
[[Netregistry Pay]]<br />
[[NTPNow]]<br />
[[Offline Credit Card]]<br />
[[Optimal Payments]]<br />
[[Payflow Pro]]<br />
[[Pay Junction]]<br />
[[PayPal Payments Pro]]<br />

</div>
<div class="col-sm-4">

[[Planet Authorize]]<br />
[[PSIGate]]<br />
[[Quantum Gateway]]<br />
[[Secure Trading]]<br />
[[SagePay]]<br />
[[SecurePay]]<br />
[[SecurePay AU]]<br />
[[TrustCommerce]]<br />
[[USA ePay]]<br />
[[WorldPay Invisible]]<br />
[[WorldPay Invisible|WorldPay Invisible XML]]

</div>
</div>

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]] || [[Quantum Vault]]
|-
| [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || [[EWAY Rapid 3.1]]
|-
| [[Stripe]]
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[2CheckOut]]
| width="33%" |
| width="33%" |
|-
| [[Authorize.net#Echeck_Module|Authorize.net Echeck]] || [[Bank Transfer]] ||
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CC Avenue]]
|-
| [[CashU]] || [[ChronoPay]] || [[Direct Debit]]
|-
| [[F2B|Cobrança - F2b]] || [[Forte]] ||
|-
| [[e-Path]] || || [[Gate2Shop]]
|-
| || || [[iDEALMollie|iDEAL via Mollie]]
|-
| [[inpay]] || [[Mail In Payment]] || [[Modulo Moip]]
|-
| || [[Skrill_1-Tap]] || [[SlimPay]]
|-
| [[NoChex]] || [[PagSeguro]] || [[PayPal]]
|-
| [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]]
|-
| [[Paymate_AU_and_NZ]] || [[Payment Express]] || [[Paymex]]
|-
| [[Payza]] || [[Planet Authorize]] ||
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

Payment Gateways

2018-09-11T06:10:13Z

NickH: /* Merchant Gateways */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup >> Payments >> Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so 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 & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation 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. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation 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 indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

<div class="row">
<div class="col-sm-4">

[[AsiaPay]]<br />
[[Authorize.net]]<br />
[[BluePay]]<br />
[[CamTech]]<br />
[[Cyberbit]]<br />
[[eMatters]]<br />
[[eProcessingNetwork]]<br />
[[FastHosts]]<br />
[[IMSP]]<br />
[[IP.Pay]]<br />
[[Kuveytturk|Kuveytturk Bank]]<br />

</div>
<div class="col-sm-4">

[[LinkPoint]]<br />
[[Merchant Partners]]<br />
[[Moneris]]<br />
[[Merchant Warrior]]<br />
[[NaviGate]]<br />
[[NETbilling]]<br />
[[Netregistry Pay]]<br />
[[NTPNow]]<br />
[[Offline Credit Card]]<br />
[[Optimal Payments]]<br />
[[Payflow Pro]]<br />
[[Pay Junction]]<br />
[[PayPal Payments Pro]]<br />

</div>
<div class="col-sm-4">

[[Planet Authorize]]<br />
[[PSIGate]]<br />
[[Quantum Gateway]]<br />
[[Secure Trading]]<br />
[[SagePay]]<br />
[[SecurePay]]<br />
[[SecurePay AU]]<br />
[[TrustCommerce]]<br />
[[USA ePay]]<br />
[[WorldPay Invisible]]<br />
[[WorldPay Invisible|WorldPay Invisible XML]]

</div>
</div>

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[Accept.js by Authorize.net]]
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
|-
| [[Moneris#Moneris_Vault|Moneris Vault]] || [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]] || [[Quantum Vault]]
|-
| [[SagePay#SagePay_Tokens|SagePay Tokens]] || [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || [[EWAY Rapid 3.1]]
|-
| [[Stripe]]
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[AlertPay]]
| width="33%" |
|-
| [[Authorize.net#Echeck_Module|Authorize.net Echeck]] || [[Bank Transfer]] || [[BidPay]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CC Avenue]]
|-
| [[CashU]] || [[ChronoPay]] || [[Direct Debit]]
|-
| [[F2B|Cobrança - F2b]] || [[Forte]] || [[E-Gold]]
|-
| [[e-Path]] || [[EWAY_UK]] || [[Gate2Shop]]
|-
| [[GoCardless]] || [[iDEAL]] || [[iDEALMollie|iDEAL via Mollie]]
|-
| [[inpay]] || [[Mail In Payment]] || [[Modulo Moip]]
|-
| [[Skrill]] || [[Skrill_1-Tap]] || [[SlimPay]]
|-
| [[NoChex]] || [[PagSeguro]] || [[PayPal]]
|-
| [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]] || [[Payson]]
|-
| [[Paymate_AU_and_NZ]] || [[Payment Express]] || [[Paymex]]
|-
| [[Payza]] || [[Planet Authorize]] || [[ProtX VSP Form]]
|-
| [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==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==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.

FreeRadius Addon Module

2018-09-07T18:09:12Z

NickH: /* FAQ's */

__TOC__
FreeRADIUS is the popular open source RADIUS server solution and is the most widely deployed RADIUS server in the world. It supports all common authentication protocols, and the server comes with a PHP-based web user administration tool, called dialupadmin. It is the basis for many commercial RADIUS products and services, like embedded systems, RADIUS appliances that support Network Access Control and WiMAX. Source: [http://en.wikipedia.org/wiki/FreeRADIUS Wikipedia:FreeRADIUS]

Typically we find users of WHMCS utilizing FreeRadius to offer Dial Up Internet & Broadband Services. We have created an addon module to integrate with FreeRadius that supports the following:

*account creation
*suspensions
*unsuspension
*terminations
*password resets
*upgrading/downgrading of accounts between FreeRADIUS groups

Usage statistics for the current billing cycle/period will be displayed to end users inside the WHMCS client area. This provides statistics on their upload and download usage, number of logins and total login time. The output, styling and content of this can be customized via the freeradius_ClientArea function within the module.

The module will provision a new account to a specific group, but is not capable of provisioning an account with specific resources. You must define the resources for a given account on the FreeRADIUS system itself.

==Buying the Addon==

The FreeRadius Addon Module is available for $150 and can be purchased via the link below.

https://www.whmcs.com/members/cart.php?a=add&pid=160

==Installing & Using FreeRadius within WHMCS==

Once you've purchased the FreeRadius addon, you will receive an email once activated directing you where to download the addon from. Once downloaded, the freeradius module folder simply needs to be uploaded to the '''/modules/servers/freeradius/''' folder of your WHMCS installation (you will need to create this).

This FreeRadius module interacts directly with the Radius database system and so once installed, you then need to go to '''Setup > Products/Services > Servers''' and create a server for the FreeRadius accounts entering the details as follows:

*'''Name''' - Anything you choose
*'''IP Address''' - SQL Hostname
*'''Server Type''' - Freeradius
*'''Username''' - SQL Username
*'''Password''' - SQL Password
*'''Access Hash''' - SQL Database Name

Next it's time to create a product, this is done under '''Setup > Products/Services > Product/Services''' as with any product in WHMCS. From there select the Add New Product option, specify a name, description & pricing, etc... all as desired, and then on the Module Settings tab, select the '''Freeradius''' module option and enter the '''Group Name''' defined in Radius to control the permissions/limitations of the account this product should setup.

That's all there is to it. You can then begin using the module in WHMCS as with any module, either manually invoking via the Module Command buttons displayed on a clients instance of the product, using the automated setup options of instantly upon order, after first payment or after manual admin review, and with the automated actions of overdue suspension, reactivations, late terminations, etc...

==FAQ's==

#'''Does this module work with PostgreSQL?'''
#*At this time the module only works with MySQL. As the module is provided as plain source code, you may however modify the code so that it works with a PostgreSQL system instead.
#'''I can't see a users stats when logged into the admin area?'''
#*The stats are only shown on the client area side. You'll need to 'Login as...' to view the stats for a particular account.
#'''I keep getting this error - "FreeRadius Database Query Error: Access denied for user 'vivieqsg_whmcs'@'localhost' to database 'radius'".'''
#*The MySQL user does not have permissions to access your FreeRADIUS database. If you're hosting WHMCS and FreeRADIUS on different system (which isn't unusual), then you must make sure the MySQL user and host from which the MySQL user is connecting from, have permissions to access the database.
#'''I keep getting this error - "ERROR 2003 (HY000): Can't connect to MySQL server on 'ip.add.res.s' (110)".'''
#*This usually means MySQL is not set to listen to outside connections or there is a firewall blocking the connections. Please ensure the IP address from which the module is connecting from is whitelisted in your firewall or that MySQL is set to allow external connections to it.
#'''I get this error when trying to use the Module Commands - "FreeRadius Database Query Error: Table 'radius.usergroup' doesn't exist".'''
#*This means the module is trying to get or put data into your FreeRADIUS MySQL database, but the table either doesn't exist or is named something else. If this happens, you should get a list of the tables in your FreeRADIUS database and compare them with the error you've gotten. It may be necessary at this point to review and adjust the code of the module so that the module uses the names of tables in your database.
#'''How does the module configure usernames?'''
#*The module will provision accounts and setup usernames based on the email address of the client. It will attempt to use the full email address as the username though if the username is already in use it will use the email address plus some numbers so each username is unique.
#'''How can I sync the name and contact information between WHMCS and FreeRADIUS?'''
#*This information can be synced between WHMCS and FreeRADIUS by locating and uncommenting the following code in the freeradius.php file. This will allow the name and contact details of the client in WHMCS to sync over to the users FreeRADIUS account.

<source lang="php">
/*
* For the name and contact details of the client in WHMCS to sync over to the users FreeRADIUS account,
* use the following code snippet:
*

$freeradiussql
->from('userinfo')
->insert(array(
'username' => $username,
'name' => $params["clientsdetails"]["firstname"] . ' ' . $params["clientsdetails"]["lastname"],
'mail' => $email,
'department' => '',
'homephone' => $params["clientsdetails"]["phonenumber"],
'workphone' => '',
'mobile' => '',
));
*/
</source>

#'''How do I specify additional radius configuration parameters for new accounts?'''
#*To apply additional radius parameters to new accounts, simply locate and uncomment the following code in the freeradius.php file, adjusting the values given for the attribute, value and op in the MySQL query on the first of those lines as required for your additional configuration parameter.

<source lang="php">

/*
* To apply additional radius parameters to new accounts, use the following code snippet
* for each additional parameter:
*

$freeradiussql
->from('radcheck')
->insert(array(
'username' => $username,
'attribute' => '<attribute-name>',
'value' => '<attribute-value>',
'op' => ':=',
));

*/
</source>

USA ePay

2018-08-28T12:36:05Z

NickH:

{{gateways
| type = cc
| onetime = yes
| recurring = yes
}}
==Setup==
# Begin by activating the '''USA ePay''' module in ''Setup > Payments > Payment Gateways''
# USA ePay uses a Key and PIN for authentication. Upon activation, you will be asked to enter these details.
#* These can be found inside your USA ePay portal under Settings > API Keys
# Customise the Display Name as desired, we recommend ''Credit Card''
# Click '''Save Changes''' to complete the setup

USA ePay is now active and ready for use.

{{modules}}