Payment Gateways - Revision history

SarahK: /* Custom Gateways */

2024-02-07T16:55:51Z

‎Custom Gateways

SarahK: /* Setting Up Gateway Modules */

2023-12-07T14:14:36Z

‎Setting Up Gateway Modules

SarahK: /* Merchant Gateways */

2023-07-27T18:13:51Z

‎Merchant Gateways

Jonathan.newton at 18:57, 21 December 2022

2022-12-21T18:57:50Z

SarahK: /* Deactivating Gateway Modules */

2022-11-29T16:54:16Z

‎Deactivating Gateway Modules

SarahK at 16:04, 7 September 2022

2022-09-07T16:04:46Z

PeterM: /* Deactivating Gateway Modules */

2022-05-17T12:32:35Z

‎Deactivating Gateway Modules

SarahK: /* Deactivating Gateway Modules */

2022-05-03T13:38:00Z

‎Deactivating Gateway Modules

SarahK at 16:16, 29 April 2022

2022-04-29T16:16:26Z

SarahK: /* Supported Gateway Modules */

2022-04-21T16:21:40Z

‎Supported Gateway Modules

@@ Line 133: / Line 133: @@
 | [[WorldPay]]
 |}
 ===Custom Gateways===

@@ Line 18: / Line 18: @@
 [[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]
-Each gateway has its own specific API requirements in order to process transactions, which vary from gateway to gateway. However, all gateways have three core options:
+Each gateway has its own specific requirements in order to process transactions, which vary from gateway to gateway. However, all gateways have three core options:
 *'''Show on Order Form''' — Whether to display the payment gateway on the order form and client area, subject to product group gateway restrictions. Also controls adding new payment details via the [[Admin Area]] for merchant gateways.
-*'''Visible Name''' — The gateway's name throughout the system and to clients (for example, an [[Authorize.net]] gateway could use the visible name ''Credit Card'').
+*'''Display Name''' — The gateway's name throughout the system and to clients (for example, an [[Authorize.net]] gateway could use the visible name ''Credit Card'').
 *'''Convert To For Processing''' — When using multiple gateways, some gateways may not accept all the currencies you offer on your site. For those that don’t, you can choose a currency here for WHMCS to convert to before sending to them.
 ** For example, if using Google Checkout with a UK account but offering prices in GBP '''and''' USD, you would need to select GBP for '''Convert To'''. This will use the rates in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies''', to do the conversion. You can set this to auto-update daily.

@@ Line 54: / Line 54: @@
 ===Merchant Gateways===
-−
 Any gateways showing in blue below indicate that further information relating to the setup and use of that gateway is available by clicking on the name.
-−
 {| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
 |-
@@ Line 65: / Line 65: @@
 | [[eMatters]] || [[eProcessingNetwork]] || [[IP.Pay]]
 |-
-| [[Kuveytturk]] || [[LinkPoint]] || [[Merchant Partners]]
+| [[Kuveytturk]] || [[Merchant Partners]] || [[Moneris]]
 |-
-| [[Moneris]] || [[Merchant Warrior]] || [[NaviGate]]
+| [[Merchant Warrior]] || [[NaviGate]] || [[NETbilling]]
 |-
-| [[NETbilling]] || [[Netregistry Pay]] || [[Offline Credit Card]]
+| [[Netregistry Pay]] || [[Offline Credit Card]] || [[Optimal Payments]]
 |-
-| [[Optimal Payments]] || [[Payflow Pro]] || [[Pay Junction]]
+| [[Payflow Pro]] || [[Pay Junction]] || [[PayPal Payments Pro]]
 |-
-| [[PayPal Payments Pro]] || [[Planet Authorize]] || [[PSIGate]]
+| [[Planet Authorize]] || [[PSIGate]] || [[Quantum Gateway]]
 |-
-| [[Quantum Gateway]] || [[Secure Trading]] || [[SagePay]]
+| [[Secure Trading]] || [[SagePay]] || [[SecurePay]]
 |-
-| [[SecurePay]] || [[SecurePay AU]] || [[TrustCommerce]]
+| [[SecurePay AU]] || [[TrustCommerce]] || [[USA ePay]]
 |-
-| [[USA ePay]] || [[WorldPay Invisible]] ||
+| [[WorldPay Invisible]] ||  ||
 |}

@@ Line 104: / Line 104: @@
 ===Third Party Gateways===
-−
 {| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
 |-
@@ Line 115: / Line 115: @@
 | [[CashU]] || [[CC Avenue]] || [[ChronoPay]]
 |-
 | [[F2B|Cobrança - F2b]] || [[Direct Debit]] || [[e-Path]]
 |-
 | [[Forte]] || [[Gate2Shop]] || [[GoCardless]]
 |-
 | [[IDEALMollie|iDeal via Mollie]] || [[inpay]] || [[Mail In Payment]]
@@ Line 127: / Line 127: @@
 | [[PayPal Basic]] || [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]]
 |-
-| [[Payson]] || [[Planet Authorize]] || [[Skrill]]
+| [[Planet Authorize]] || [[Skrill]] || [[Skrill 1-Tap]]
 |-
-|  [[Skrill 1-Tap]] || [[SlimPay]] || [[Finansbank|Turkish Finansbank]]
+| [[SlimPay]] || [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]]
 |-
-| [[GarantiBank|Turkish Garanti Bank]] || [[WorldPay]]
+| [[WorldPay]]
 |}

@@ Line 142: / Line 142: @@
 ==Deactivating Gateway Modules==
-[[File:Deactivate Payment Module.png|thumb|Deactivate Gateway]]
+When you stop using a payment gateway, make certain to deactivate it. Deactivation prevents new payments using this gateway and will automatically reassign any products, services, invoices, transactions, and pay methods to the new payment gateway.
-To stop using a payment gateway, click '''Deactivate'''. This will prevent any further payments using this gateway and will automatically reassign any products, services, invoices, transactions, and pay methods to the new payment gateway.
+To deactivate a payment gateway, click '''Deactivate'''. The system will prompt you to select an alternative payment gateway.
-When you click '''Deactivate''', a window will appear and will prompt the user to select an alternative payment gateway. Change any currently-assigned items to this gateway.
+Change any currently-assigned items to this gateway.
 ===Migrating Payment Gateways===

← Older revision		Revision as of 16:04, 7 September 2022
Line 2:		Line 2:

	You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.		You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
		+
		+	== Activating a Payment Gateway ==
		+
		+	To activate a new payment gateway:
		+
		+	# Find the payment gateway:
		+	#* In WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations\|Apps & Integrations]]'''.
		+	#* In WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways'''.
		+	#* In WHMCS 7.10 and earlier, go to '''Setup > Payments > Payment Gateways'''.
		+	# Click '''Activate'''.
		+	# Configure the payment gateway (see below).

	==Setting Up Gateway Modules==		==Setting Up Gateway Modules==

@@ Line 133: / Line 133: @@
 [[File:Deactivate.png|thumb|Deactivate Gateway]]
-If you no longer wish to use a particular payment gateway, click '''Deactivate''' to gracefully remove the gateway from the system. This will prevent any further payments using this gateway and automatically reassign any products, services, invoices, transactions, and pay methods to the new payment gateway.
+To stop using a payment gateway, click '''Deactivate'''. This will prevent any further payments using this gateway and will automatically reassign any products, services, invoices, transactions, and pay methods to the new payment gateway.
-When you click the deactivate link, a window will appear and prompt the user to select an alternative payment gateway, to which you should change any currently-assigned items.
+When you click '''Deactivate''', a window will appear and will prompt the user to select an alternative payment gateway. Change any currently-assigned items to this gateway.
 ===Migrating Payment Gateways===
-Sometimes, you may want to stop using one payment gateway and switch to another. For more information, see [[Migrating Payment Gateways]].
+For instructions to stop using one payment gateway and switch to another, see [[Migrating Payment Gateways]].
 ==Test Credit Card Numbers==

@@ Line 9: / Line 9: @@
 Each gateway has its own specific API requirements in order to process transactions, which vary from gateway to gateway. However, all gateways have three core options:
-*'''Show on Order Form''' — Whether to display the payment gateway on the order form and client area, subject to product group gateway restrictions. Also controls adding new payment details via the admin area for merchant gateways.
+*'''Show on Order Form''' — Whether to display the payment gateway on the order form and client area, subject to product group gateway restrictions. Also controls adding new payment details via the [[Admin Area]] for merchant gateways.
-*'''Visible Name''' — The gateway's name throughout the system and to clients (for example, an Authorize.net gateway could use the visible name ''Credit Card'').
+*'''Visible Name''' — The gateway's name throughout the system and to clients (for example, an [[Authorize.net]] gateway could use the visible name ''Credit Card'').
 *'''Convert To For Processing''' — When using multiple gateways, some gateways may not accept all the currencies you offer on your site. For those that don’t, you can choose a currency here for WHMCS to convert to before sending to them.
-** For example, if using Google Checkout with a UK account but offering prices in GBP and USD, you would need to select GBP in the Convert To box. This will use the rates in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies''', to do the conversion. You can set this to auto-update daily.
+** For example, if using Google Checkout with a UK account but offering prices in GBP '''and''' USD, you would need to select GBP for '''Convert To'''. This will use the rates in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies''', to do the conversion. You can set this to auto-update daily.
-** For more information, see '''Converting Invoices to a New Currency'''.
+** For more information, see [[Converting Invoices to a New Currency]].
 ==Supported Gateway Modules==
-The following is a list of all the payment gateways that WHMCS includes by default:
+WHMCS includes the following payment gateways by default:
 * '''Merchant Gateways''' store credit card information securely in the WHMCS database.
-* '''Third-Party Gateways''' take the client to the provider's website to process payments off-site.
+* '''Third-Party Gateways''' direct the client to the provider's website to process payments off-site.
-* '''Tokenisation Gateways''' can perform repeat billing by storing the original transaction details or a reference number and not the full credit card number.
+* '''Tokenisation Gateways''' reduce PCI liabilities when they perform repeat billing by storing the original transaction details or a reference number and not the full credit card number. For more information, see [[Working with Tokenization]].
-For tokenisation gateways with the '''Remote Update Card''' feature, clients can enter their card details via the WHMCS Client Area. This is done via an interface hosted by the payment gateway directly or by paying an invoice. This creates a profile in the payment gateway's system that returns a token. WHMCS uses this to use for managing the card detail update requests via the Client Area and recurring payments. The full card details are not stored on your server, and, for some token gateways never touch it.
+=== Remote Update Card ===
-The type of payment gateway that you select influences which invoice notification [[Email Templates|email template]] it sends. Third-party gateways will send the '''Invoice Created''' email template, while merchant and tokenisation gateways will send the '''Credit Card Invoice Created''' email template. This allows you to customise the payment instructions to clients for the different payment processes.
+For tokenisation gateways with the '''Remote Update Card''' feature, clients can enter their card details via the WHMCS Client Area. This is done via an interface that the payment gateway hosts directly or by paying an invoice. This creates a profile in the payment gateway's system that returns a token.
-The type of payment gateway also influences the behaviour of the '''Attempt Capture''' button on the invoice page in the admin area. For third-party gateways, the system will deactivate the button because the client needs to click the payment button on the invoice to send payment. For merchant gateways and tokenisation gateways, the button will be active and staff can click '''Attempt Capture''' to instantly capture payment from the client's credit card.
+WHMCS uses this to manage the card detail update requests via the Client Area and recurring payments. This does not store the full card details on your server, and some token gateways never touch it.
-Any gateways showing in blue below indicate that further information relating to the setup and use of that gateway is available by clicking on the name.
+=== Email Templates ===
 ===Merchant Gateways===
 {| width="100%" cellpadding="2" style="width:100%;" class="table table-striped"
@@ Line 62: / Line 73: @@
 ===Tokenisation Gateways===
-For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the system won't add the token to WHMCS until someone has submitted a payment through the module. The system will store the credit card details in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. After the payment is complete, the system fetches the token and replaces the credit card details in the database. Storage of the credit card details can also happen when the client updates their credit card details or when they place an order and it does not process the payment immediately.
+Tokenisation gateways store a token to use for processing credit card payments through the merchant gateway module. The system won't add the token to WHMCS until someone has submitted a payment through the module. The system will store the credit card details in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. After the payment is complete, the system fetches the token and replaces the credit card details in the database. Storage of the credit card details can also happen when the client updates their credit card details or when they place an order and the system does not process the payment immediately.
 <div class="docs-alert-warning">
@@ Line 114: / Line 125: @@
 ===Custom Gateways===
-It is also possible to create your own gateway modules for WHMCS if you want to integrate with a gateway that WHMCS doesn't offer by default.
+You can create your own gateway modules for WHMCS if you want to integrate with a gateway that WHMCS doesn't offer by default.
 For more information, see our [https://developers.whmcs.com/ Developer Documentation].
@@ Line 122: / Line 133: @@
 [[File:Deactivate.png|thumb|Deactivate Gateway]]
-If you no longer wish to use a particular payment gateway, clicking '''Deactivate''' beside the name will gracefully remove the gateway from the system.  This will prevent any further payments using this gateway and automatically reassign any products, services, invoices, transactions and pay methods to the new payment gateway.
+If you no longer wish to use a particular payment gateway, click '''Deactivate''' to gracefully remove the gateway from the system. This will prevent any further payments using this gateway and automatically reassign any products, services, invoices, transactions, and pay methods to the new payment gateway.
 When you click the deactivate link, a window will appear and prompt the user to select an alternative payment gateway, to which you should change any currently-assigned items.
@@ Line 132: / Line 143: @@
 ==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.
+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