EWAY - Revision history

JuanR: /* Migrating to eWAY from eWAY Rapid 3.1 */

2024-04-14T12:17:06Z

‎Migrating to eWAY from eWAY Rapid 3.1

SarahK at 17:35, 7 February 2024

2024-02-07T17:35:14Z

John: /* Troubleshooting */

2023-02-07T13:05:23Z

‎Troubleshooting

SarahK: /* Adding the EWAY Payment Gateway */

2022-09-28T19:20:16Z

‎Adding the EWAY Payment Gateway

SarahK: /* Adding the EWAY Payment Gateway */

2022-09-07T20:19:27Z

‎Adding the EWAY Payment Gateway

SarahK at 19:40, 24 March 2022

2022-03-24T19:40:34Z

SarahK: /* Creating eWAY Configuration Data */

2020-08-06T15:52:23Z

‎Creating eWAY Configuration Data

John: /* Creating eWAY Configuration Data */

2020-01-03T12:17:24Z

‎Creating eWAY Configuration Data

Andrew at 10:44, 13 December 2019

2019-12-13T10:44:15Z

Andrew at 10:41, 13 December 2019

2019-12-13T10:41:53Z

@@ Line 42: / Line 42: @@
 #Obtain the Public API Key from eWAY (see above).
 #Log in to the WHMCS Admin Area.
-#Navigate to the Setup menu.
+# Go to the appropriate location for your version of WHMCS:
-#Click on the Payments option, and then again on Payment gateways.
+#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
-#Enter your administrator password if prompted.
+#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
-#Click on the '''Manage Existing Gateways''' button and locate the eWAY Rapid Module.
+#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
 #Click on the '''Migrate to eWAY Module''' button.
 #Enter the Public API Key where prompted and press the '''Migrate''' button

@@ Line 55: / Line 55: @@
 ==Troubleshooting==
 ===Card Fields are Not Displayed===
-The '''Card Number''', '''Expiry Date''' and '''CVV Number''' fields may not display on the shopping cart or the Manage Pay Methods page in the shopping cart, at '''Hello, User! > Payment Methods''' in the Client Area, or when you click '''Add Credit Card''' in the '''[[Summary_Tab|Summary]]''' tab in the client profile.
+The '''Card Number''', '''Expiry Date''' and '''CVV Number''' fields may not display on the shopping cart or the Manage Pay Methods page in the shopping cart, at '''Hello, User! > Payment Methods''' in the Client Area, or when you click '''Add Credit Card''' in the '''[[Clients:Summary_Tab|Summary]]''' tab in the client profile.
 This indicates that eWAY is rejecting the eWAY API key in the configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]. This might occur if you entered the API key incorrectly, it has expired, or eWAY revoked it.

@@ Line 54: / Line 54: @@
 ==Troubleshooting==
-''N/A''
+This indicates that eWAY is rejecting the eWAY API key in the configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]. This might occur if you entered the API key incorrectly, it has expired, or eWAY revoked it.
 {{modules}}

@@ Line 19: / Line 19: @@
 # Go to the appropriate location for your version of WHMCS:
-#* For WHMCS 8.6 and later, go to '''Addons > [[Apps and Integrations|Apps & Integrations]]''' or '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations'''.
+#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
-#* For WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
+#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
 # Click '''EWAY'''.
 # Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
@@ Line 41: / Line 40: @@
 If the WHMCS installation has existing tokens stored from the previous module, a button will be shown on the Payment Gateways configuration page to swiftly migrate the tokens to the new module.
-#Obtain the Public API Key from eWAY as detailed above.
+#Obtain the Public API Key from eWAY (see above).
-#Log into your WHMCS admin area.
+#Log in to the WHMCS Admin Area.
 #Navigate to the Setup menu.
 #Click on the Payments option, and then again on Payment gateways.

@@ Line 18: / Line 18: @@
 To set up the EWAY payment gateway in WHMCS:
-# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Payment Gateways'''.
+# Go to the appropriate location for your version of WHMCS:
-# Choose the '''All Payment Gateways''' tab.
+#* For WHMCS 8.6 and later, go to '''Addons > [[Apps and Integrations|Apps & Integrations]]''' or '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations'''.
 # Click '''EWAY'''.
 # Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes features available in version 7.9 and above</div>
+<div class="docs-alert-info">We added this module in WHMCS 7.9. It supersedes the [[EWAY Rapid 3.1]] module.</div>
-This module supersedes the [[EWAY Rapid 3.1]] module.
+eWAY lets WHMCS users to accept online credit card payments easily and securely so they can grow their business fast. The Secure Fields solution allows merchants to securely and seamlessly process payments from their own website, without exposing the sensitive card data.
 {{gateways
 | type = token
@@ Line 10: / Line 14: @@
 }}
-eWAY lets WHMCS users to accept online credit card payments easily and securely so they can grow their business fast.
+== Adding the EWAY Payment Gateway ==
-−
-eWAY’s Secure Fields solution allows merchants to securely and seamlessly process payments from their own website, without exposing the sensitive card data.
+To set up the EWAY 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 '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''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 eWAY Configuration Data===
+===Migrating to eWAY from eWAY Rapid 3.1===
 The eWAY Rapid 3.1 module included in previous versions of WHMCS can be easily replaced with the eWAY module.
 If the WHMCS installation has existing tokens stored from the previous module, a button will be shown on the Payment Gateways configuration page to swiftly migrate the tokens to the new module.
@@ Line 51: / Line 52: @@
 <div class="docs-alert-info"><i class="fa fa-question-circle"></i> The Migrate to eWAY Module will only show if the WHMCS installation has Payment Methods associated with the eWAY Rapid Payments module.</div>
-===Not using eWAY? ===
+==Troubleshooting==
 {{modules}}

@@ Line 26: / Line 26: @@
 To connect your store to eWAY, it only requires a few simple steps.
-#Create an [https://my.eway.io/whmcs eWay account]
+#Create an [https://my.eway.io/whmcs eWay account].
-#Log in to the [https://my.eway.io MYeWAY Dashboard]
+#Log in to the [https://my.eway.io MYeWAY Dashboard].
-#Navigate to My Account > API Key.
+#Navigate to '''My Account > API Key'''.
-#Copy and Paste your API Key and API Password into WHMCS
+#Copy and paste your '''API Key''' and '''API Password''' into WHMCS
-#Copy and Paste your Public API Key, labeled as '''Pay Now Button Public API key''' into WHMCS
+#Copy and paste your '''Public API Key''', labeled as '''Pay Now Button Public API key''', into WHMCS.
 <div class="docs-alert-info">'''Still need help to configure eWAY?''' Call +61 2 6175 3000 to speak with eWAY now.</div>

@@ Line 44: / Line 44: @@
 #Enter your administrator password if prompted.
 #Click on the '''Manage Existing Gateways''' button and locate the eWAY Rapid Module.
-#Click on the '''Migrate to eWAY Module''' button and follow the instructions in the modal.
+#Click on the '''Migrate to eWAY Module''' button.
-##Enter the Public API Key where prompted and press the '''Migrate''' button
+#Enter the Public API Key where prompted and press the '''Migrate''' button
 #The page will save and reload showing the eWAY module is active and the eWAY Rapid Module disabled
 #Update any configuration on the newly activated module as required.