Difference between revisions of "EWAY"

From WHMCS Documentation

(Created page with '{{gateways | type = cc | onetime = yes | recurring = yes | refund =yes }} {{modules}}')
 
(→‎Migrating to eWAY from eWAY Rapid 3.1)
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<div class="docs-alert-info">We added this module in WHMCS 7.9. It supersedes the [[EWAY Rapid 3.1]] module.</div>
 +
 +
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.
 +
 +
<div class="docs-alert-info">[https://my.eway.io/whmcs Create an eWAY Account]</div>
 +
 +
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.
 
{{gateways
 
{{gateways
−
| type = cc
+
| type = token
 
| onetime = yes
 
| onetime = yes
 
| recurring = yes
 
| recurring = yes
−
| refund =yes
+
| refunds = yes
 +
| updatecc = yes
 
}}
 
}}
 +
 +
== Adding the EWAY Payment Gateway ==
 +
 +
To set up the EWAY payment gateway in WHMCS:
 +
 +
# Go to the appropriate location for your version of WHMCS:
 +
#* 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 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.
 +
# Create and enter your EWAY credentials:
 +
## Create an [https://my.eway.io/whmcs eWay account].
 +
## Log in to the [https://my.eway.io MYeWAY Dashboard].
 +
## Go to '''My Account > API Key'''.
 +
## Copy and paste your API key and password into WHMCS. For information on setting up your API key and password, see the [https://go.eway.io/s/article/How-do-I-setup-my-Live-eWAY-API-Key-and-Password eWAY Knowledge base.].
 +
## Copy and paste your public API key ('''Pay Now Button Public API key''') into WHMCS. For information on obtaining your Public API Key, see [https://go.eway.io/s/article/How-do-I-find-my-Public-API-Key Finding my Public API Key]
 +
# 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 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.
 +
 +
#Obtain the Public API Key from eWAY (see above).
 +
#Log in to the WHMCS Admin Area.
 +
# Go to the appropriate location for your version of WHMCS:
 +
#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
 +
#* 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'''.
 +
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
 +
#Click on the eWAY Rapid Module.
 +
#Click on the '''Migrate to eWAY Module''' 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.
 +
 +
<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>
 +
 +
==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 '''[[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.
 +
 +
To resolve the error, perform steps 4 and 5 from [[#Adding_the_EWAY_Payment_Gateway|Adding the EWAY Payment Gateway]] above.
  
 
{{modules}}
 
{{modules}}

Latest revision as of 12:17, 14 April 2024

We added this module in WHMCS 7.9. It 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.

Create an eWAY Account

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.

Supported Features

Type One Time Recurring Refunds 3D Secure
Token Yes Yes Yes No
Remote Update Card Remote Delete Card AddPayMethod API
Yes No No

Adding the EWAY Payment Gateway

To set up the EWAY payment gateway in WHMCS:

  1. Go to the appropriate location for your version of WHMCS:
    • For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
    • For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose All Payment Gateways.
  2. Click EWAY.
  3. Check Show on Order Form to display this payment method in the Client Area during checkout.
  4. Create and enter your EWAY credentials:
    1. Create an eWay account.
    2. Log in to the MYeWAY Dashboard.
    3. Go to My Account > API Key.
    4. Copy and paste your API key and password into WHMCS. For information on setting up your API key and password, see the eWAY Knowledge base..
    5. Copy and paste your public API key (Pay Now Button Public API key) into WHMCS. For information on obtaining your Public API Key, see Finding my Public API Key
  5. 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 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.

  1. Obtain the Public API Key from eWAY (see above).
  2. Log in to the WHMCS Admin Area.
  3. Go to the appropriate location for your version of WHMCS:
    • For WHMCS 8.6 and later, go to Configuration () > System Settings > Payment Gateways.
    • For WHMCS 8.0 and later, go to Configuration () > System Settings > Payment Gateways and choose Manage Existing Gateways.
    • For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose Manage Existing Gateways.
  4. Click on the eWAY Rapid Module.
  5. Click on the Migrate to eWAY Module button.
  6. Enter the Public API Key where prompted and press the Migrate button
  7. The page will save and reload showing the eWAY module is active and the eWAY Rapid Module disabled
  8. Update any configuration on the newly activated module as required.
The Migrate to eWAY Module will only show if the WHMCS installation has Payment Methods associated with the eWAY Rapid Payments module.

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 in the client profile.

This indicates that eWAY is rejecting the eWAY API key in the configuration at Configuration () > System Settings > Payment Gateways. This might occur if you entered the API key incorrectly, it has expired, or eWAY revoked it.

To resolve the error, perform steps 4 and 5 from Adding the EWAY Payment Gateway above.

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


Retrieved from "http://3.17.75.209/index.php?title=EWAY&oldid=34539"