Difference between revisions of "EWAY Rapid 3.1"

Latest revision as of 19:48, 21 April 2022

About this Module

We removed this module in WHMCS 7.8. For WHMCS 7.9 and above, use the EWAY module.

This eWAY module lets WHMCS users accept credit card payments using eWAY’s Rapid API - Transparent Redirect method. This allows merchants to securely process payments from their website without exposing the sensitive card data.

The WHMCS integration includes token payments, which allow customers to securely store the card information within eWAY’s PCI DSS environment. WHMCS uses the token (representing the saved card) to handle all future payments.

Supported Features

Type	One Time	Recurring	Refunds	3D Secure
Token	Yes	Yes	Yes	Yes

Remote Update Card	Remote Delete Card	AddPayMethod API
Yes	No	No

Adding the eWAY Rapid 3.1 Payment Gateway

To set up the eWAY Rapid 3.1 payment gateway in WHMCS:

Go to Setup > Products/Services > Payment Gateways.
Choose the All Payment Gateways tab.
Click eWAY Rapid 3.1.
Check Show on Order Form to display this payment method in the Client Area during checkout.
Create your API credentials with eWay.
Enter your eWAY credentials.
Click Save Changes.

Test Mode

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

Migrating to eWAY Rapid 3.1

We removed this module in WHMCS 7.8. This information only applies to WHMCS 6.0 through 7.7. For WHMCS 7.9 and above, we strongly recommend using the EWAY module.

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 the eWAY website.

Payments 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.

Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible

@@ Line 1: / Line 1: @@
+== About this Module ==
+<div class="docs-alert-warning">
+We removed this module in WHMCS 7.8. For WHMCS 7.9 and above, use the [[EWAY]] module.
+</div>
+This eWAY module lets WHMCS users accept credit card payments using eWAY’s Rapid API - Transparent Redirect method. This allows merchants to securely process payments from their website without exposing the sensitive card data.
+The WHMCS integration includes token payments, which allow customers to securely store the card information within eWAY’s PCI DSS environment. WHMCS uses the token (representing the saved card) to handle all future payments.
 {{gateways
 | type = token
@@ Line 6: / Line 15: @@
 | updatecc = yes
 | 3dsecure = yes
 }}
+== Adding the eWAY Rapid 3.1 Payment Gateway ==
-eWAY lets WHMCS users to accept online credit card payments easily and securely so they can grow their business fast.
-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.
-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.
+To set up the eWAY Rapid 3.1 payment gateway in WHMCS:
+# Go to '''Setup > Products/Services > [[Payment Gateways]]'''.
+# Choose the '''All Payment Gateways''' tab.
+# Click '''eWAY Rapid 3.1'''.
+# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
+# [https://go.eway.io/s/article/How-do-I-setup-my-Live-eWAY-API-Key-and-Password Create your API credentials] with eWay.
+# Enter your eWAY credentials.
+# Click '''Save Changes'''.
 ===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===
-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.]
-To connect your store to eWAY, it only requires a few simple steps.
-#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.
-#Copy and Paste your API Key and API Password into WHMCS
-<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 ==
-In earlier versions of WHMCS, there were 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”.
+<div class="docs-alert-warning">
+We removed this module in WHMCS 7.8. This information only applies to WHMCS 6.0 through 7.7. For WHMCS 7.9 and above, we '''strongly''' recommend using the [[EWAY]] module.
+</div>
-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.
+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.
-To switch to the new eWAY Rapid 3.1 module, you will need to first activate it by , following these steps:
-#Log into your WHMCS admin area.
+For more information, see [https://www.eway.com.au/contact-us the eWAY website].
-#Navigate to the Setup menu
-#Click on the Payments option, and then again on Payment gateways.
-#Enter your administrator password if prompted.
-#Click on the All Payment gateways button and, from the list of options, locate and click on the eWAY token Payments
-#Enter in a Display name as you would like this payment option to appear to your customers.
-#Enter in your  eWAY Rapid API key and Rapid API Password.
-#Click Save Changes
-<div class="docs-alert-warning">'''Note: ''' Unless you are doing Sandbox testing, set the option Test mode to No.</div>
-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 ==
-For more information or advice on the various payment gateway solutions eWAY offers, you can contact eWAY directly [https://www.eway.com.au/contact-us here]
-===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 ==
-If importing local card data to stored tokenised data in eWAY is a feature you would like, please contact WHMCS here.
-===Not using eWAY? ===
+''N/A''
-Join thousands of merchants who choose eWAY as their preferred online payment provider. Create an eWAY account and get your online store transacting quickly with our FREE WHMCS extension today.
-<div class="docs-alert-info">''' [https://my.eway.io/whmcs Create an eWAY Account]'''</div>
 {{modules}}

Documentation