EWAY Rapid 3.1 - Revision history

SarahK at 19:48, 21 April 2022

2022-04-21T19:48:27Z

SarahK: /* Migrating to eWAY Rapid 3.1 */

2022-04-01T15:38:59Z

‎Migrating to eWAY Rapid 3.1

SarahK at 15:36, 1 April 2022

2022-04-01T15:36:49Z

John: /* Migrating to the eWAY Rapid 3.1 */

2021-10-20T11:26:42Z

‎Migrating to the eWAY Rapid 3.1

SarahK: /* Creating an eWAY API key and Password */

2020-08-06T15:50:04Z

‎Creating an eWAY API key and Password

John: /* Migrating to the eWAY Rapid 3.1 */

2020-06-05T09:42:36Z

‎Migrating to the eWAY Rapid 3.1

Andrew at 10:41, 13 December 2019

2019-12-13T10:41:03Z

Andrew at 10:39, 13 December 2019

2019-12-13T10:39:45Z

Lawrence: /* Updating Clients' Credit Card Details via the Admin Area */

2018-12-29T19:42:42Z

‎Updating Clients' Credit Card Details via the Admin Area

Lawrence: /* Updating Clients' Credit Card Details via the Admin Area */

2018-12-29T19:42:22Z

‎Updating Clients' Credit Card Details via the Admin Area

@@ Line 20: / Line 20: @@
 To set up the eWAY Rapid 3.1 payment gateway in WHMCS:
-# Go to '''Setup > Products/Services > Payment Gateways'''.
+# Go to '''Setup > Products/Services > [[Payment Gateways]]'''.
 # Choose the '''All Payment Gateways''' tab.
 # Click '''eWAY Rapid 3.1'''.

@@ Line 38: / Line 38: @@
 </div>
-Version 6.0 and earlier contained modules for eWAY that did not make use of the Transparent Redirect or Token Payment storage mechanisms. If you are using one of these payment solutions, we encourage you to look at migrating to the latest integration “eWAY Rapid 3.1”.
+Version 6.0 and earlier contained modules for eWAY that did not make use of the Transparent Redirect or Token Payment storage mechanisms. After you migrate, your existing clients must log in and enter their credit card payment details manually the next time they receive an invoice. This allows the system to create a token for your client in eWAY.
 For more information, see [https://www.eway.com.au/contact-us the eWAY website].

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes features available in version 7.8 and below. For version 7.9 and above [[EWAY|click here]]</div>
+== About this Module ==
 {{gateways
 | type = token
@@ Line 7: / Line 15: @@
 | updatecc = yes
 | 3dsecure = yes
 }}
-<div class="docs-alert-warning">'''Note: ''' WHMCS recommends using the [[EWAY|eWAY]] module which replaces this module.</div>
+== Adding the eWAY Rapid 3.1 Payment Gateway ==
-The WHMCS integration uses eWAY’s Rapid API - Transparent Redirect method. This allows merchants to securely and seamlessly process payments from their own website, without exposing the sensitive card data.
+To set up the eWAY Rapid 3.1 payment gateway in WHMCS:
-−
-Further, the WHMCS integration takes advantage of Token Payments, allowing customers to securely store the card information within eWAY’s PCI DSS environment, and WHMCS uses the Token (which represent the saved card) to handle all future payments without the customer having to key in their details again.
+# Go to '''Setup > Products/Services > Payment Gateways'''.
 ===Test Mode===
-Allows you to test certain aspects of your WHMCS integration with the eWAY Sandbox. The eWAY Sandbox by default will provide a successful result for any valid transaction request. If you wish to test declined transactions, then you will want to change your Sandbox Settings from "Always Approved" to "Always Decline".
+You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.
-===Creating an eWAY API key and Password===
+== Migrating to eWAY Rapid 3.1 ==
-To accept online payment eWAY uses an API key and API password to connect to WHMCS. For a detailed guide on setting up your API Credentials, visit the [https://go.eway.io/s/article/How-do-I-setup-my-Live-eWAY-API-Key-and-Password eWAY Knowledge base.]
+<div class="docs-alert-warning">
-To connect your store to eWAY, it only requires a few simple steps.
+Version 6.0 and earlier contained modules for eWAY that did not make use of the Transparent Redirect or Token Payment storage mechanisms. If you are using one of these payment solutions, we encourage you to look at migrating to the latest integration “eWAY Rapid 3.1”.
-#Create an [https://my.eway.io/whmcs eWay account]
+If you are using a payment gateway module titled "eWAY", when switching to the eWAY Rapid 3.1 module your existing clients will need to login and enter their credit card payment details manually the first time they receive an invoice following the switch. This is so that a token can be created for your client in eWAY.
-Note: If you are using a payment gateway module titled "eWAY", when switching to the eWAY Rapid 3.1 module your existing clients will need to login and enter their credit card payment details manually the first time they receive an invoice following the switch. This is so that a token can be created for your client in eWAY.
+To switch to the new eWAY Rapid 3.1 module, you will need to activate it and then disable the older eWAY module.
-#Log into your WHMCS admin area.
+For more information, see [https://www.eway.com.au/contact-us the eWAY website].
-A Success Message will display, which confirms the setup has been complete. Once you have configured the eWAY Token Payments option, it is recommended you navigate back to the All Payment Gateways option, and disable the older eWAY module.
+== Payments via the Admin Area ==
-===Updating Clients' Credit Card Details via the Admin Area===
+Due to the impact on PCI compliance, you cannot transfer a local card to remote storage from within the Admin Area. The client must make their first payment via the Client Area in order to store their card details remotely with eWAY.
-'''Transferring a local card to remote storage from within the admin area is not currently supported, as this would impact the effectiveness of WHMCS’s commitment to lower your PCI compliance exposure. The client should make the first payment via the client area in order for WHMCS to store their card details remotely with the eWAY Tokens module.'''
+== Troubleshooting ==
-===Not using eWAY? ===
+''N/A''
 {{modules}}

@@ Line 32: / Line 32: @@
 <div class="docs-alert-info">'''Still need help to configure eWAY?''' Call +61 2 6175 3000 to speak with eWAY now.</div>
-===Migrating to the eWAY Rapid 3.1===
+===Migrating to eWAY Rapid 3.1===
 Version 6.0 and earlier contained modules for eWAY that did not make use of the Transparent Redirect or Token Payment storage mechanisms. If you are using one of these payment solutions, we encourage you to look at migrating to the latest integration “eWAY Rapid 3.1”.

@@ Line 27: / Line 27: @@
 #Create an [https://my.eway.io/whmcs eWay account]
 # Log in to the [https://www.way.com/dashboard MYeWAY Dashboard]
-#Navigate to My Account > API Key.
+#Navigate to  '''Account > My Account > API Key''' or, prior to WHMCS 8.0, '''My Account > API Key'''.
 #Copy and Paste your API Key and API Password into WHMCS

← Older revision		Revision as of 10:39, 13 December 2019
Line 1:		Line 1:
		+	<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes features available in version 7.8 and below. For version 7.9 and above [[EWAY\|click here]]</div>
	{{gateways		{{gateways
	\| type = token		\| type = token

@@ Line 54: / Line 54: @@
 '''Transferring a local card to remote storage from within the admin area is not currently supported, as this would impact the effectiveness of WHMCS’s commitment to lower your PCI compliance exposure. The client should make the first payment via the client area in order for WHMCS to store their card details remotely with the eWAY Tokens module.'''
-'''If importing local card data to stored tokenised data in eWAY is a feature you would like, please [https://requests.whmcs.com/topic/eway-token-payments-enhancements-to-module-needed Contact WHMCS here].'''
+'''If importing local card data to stored tokenised data in eWAY is a feature you would like, please [https://requests.whmcs.com/topic/eway-token-payments-enhancements-to-module-needed contact WHMCS here].'''
 ===Not using eWAY? ===