Difference between revisions of "EWAY Tokens"

Revision as of 15:38, 22 September 2015

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

eWay is a leading global merchant payment services provider that operates accross a number of countries. At the time of writing Australia, New Zealand, United Kingdom, Singapore, Hong Kong & Malaysia, with the USA scheduled to be added later this year. eWay Tokens, the name of the module available in WHMCS, is a tokenised gateway [link to Tokenised Gateways docs] that allows you to perform credit card processing and recurring billing without having to store credit card details locally.

Going one step further than a lot of other payment gateway solutions, eWay's Transparent Redirect implementation method which the WHMCS module takes advantage of provides a seamless checkout experience for customers while ensuring card details never pass through your web server, allowing you to avoid most PCI Compliance requirements and negating any of the risks normally associated with processing and storing credit cards on your website.

Creating an eWay API Account

All requests to eWAY’s Rapid API are authenticated using basic authentication, this uses the eWAY API Key and Password.

To create an API key:

Log in to your Partner Portal account
Navigate to Resources > Sandbox/Testing and click on 'Request Sandbox'
1. Note: Skip this step if you already have a Sandbox account
Navigate to the Sandbox Login page
Go to My Account > User Security > Manage Roles
Create role under name of "API KEY"
Go to My Account > User Security > Create User
Assign "API KEY" role to new user.
Choose a name, enter your email address and choose a password.
Once the role is created, click ‘actions’ dropdown menu and click "View API Key"
Select the Rapid API Key, the password you set in step 8 is the API password for this key.

For full instructions, including login links, please refer to the [Website]

Test Mode

The eWay test mode has a feature to use the "pennies" value of the invoice total to return that specific status code. To ensure this is not triggered, ensure your testing invoices have a 0 "penny" amount.

You can also set the Sandbox to always approve, by logging into the Sandbox and navigating to Settings > Sandbox and changing the transaction response to Always Approve.

Migrating to the eWay Tokens Module

In earlier versions of WHMCS, there were modules for eWay that did not make use of the Transparent Redirect or Tokenised storage mechanisms. If you are using one of these payment gateway solutions, we encourage you to look at migrating to the newer eWay Tokens module.

If you are using a payment gateway module named "eway", switching to the current module will require your clients login and enter their credit card payment details manually the first time they receive an invoice following the switch. This is so that eWay can capture your customers credit card details in order to create a token.

If you are using the payment gateway module named "eway tokens" then the current module can act as a drop-in replacement for that and the existing tokens will be able to be used by the newer module, so recurring billing can continue interupted.

To make the switch, simply activate the new module which you'll find in Setup > Payment Gateways listed as eWay Token Payments, configure it with your eWay RapidAPI credentials, and then click the deactivate button next to the older module, at which point you'll be prompted to choose a replacement payment gateway for items assigned to that currently, and there you should just select the eWay Token Payments module from the dropdown provided.

For more information or advice on the various payment gateway solutions eWay offers, you can contact eWay directly via https://www.eway.com.au/contact-us

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: @@
 {{gateways
 | type = token
+| onetime = yes
 | recurring = yes
+| refunds = yes
 | updatecc = yes
-| deletecc = yes
+}}
-}}
+eWay is a leading global merchant payment services provider that operates accross a number of countries.  At the time of writing Australia, New Zealand, United Kingdom, Singapore, Hong Kong & Malaysia, with the USA scheduled to be added later this year.
+eWay Tokens, the name of the module available in WHMCS, is a tokenised gateway [link to Tokenised Gateways docs] that allows you to perform credit card processing and recurring billing without having to store credit card details locally.
+Going one step further than a lot of other payment gateway solutions, eWay's Transparent Redirect implementation method which the WHMCS module takes advantage of provides a seamless checkout experience for customers while ensuring card details never pass through your web server, allowing you to avoid most PCI Compliance requirements and negating any of the risks normally associated with processing and storing credit cards on your website.
+===Creating an eWay API Account===
+All requests to eWAY’s Rapid API are authenticated using basic authentication, this uses the eWAY API Key and Password.
-The eWAY Tokens module allows you to process credit cards via eWAY without ever storing the full card details locally in your WHMCS installs database.  Card details are still entered on your site for a seamless checkout process, and thus you do still need to be PCI Compliant, but your risks are greatly reduced by not storing the cards locally.
+To create an API key:
-For more information, visit http://eway.com.au/developers/api/token.html
+#Log in to your Partner Portal account
+#Navigate to ''Resources > Sandbox/Testing'' and click on 'Request Sandbox'
+##Note: Skip this step if you already have a Sandbox account
+#Navigate to the Sandbox Login page
+#Go to ''My Account > User Security > Manage Roles''
+#Create role under name of "API KEY"
+#Go to ''My Account > User Security > Create User''
+#Assign "API KEY" role to new user.
+#Choose a name, enter your email address and choose a password.
+#Once the role is created, click ‘actions’ dropdown menu and click "View API Key"
+#Select the Rapid API Key, the password you set in step 8 is the API password for this key.
-==Installation==
+For full instructions, including login links, please refer to the [[https://eway.io/api-v3/#authentication|eWay Website]]
-To install the eWAY Tokens module, begin by downloading it here: http://www.whmcs.com/members/dl.php?type=d&id=134 and then upload it to the '''/modules/gateways/''' folder of your WHMCS installation
+===Test Mode===
-==Configuration==
+The eWay test mode has a feature to use the "pennies" value of the invoice total to return that specific status code. To ensure this is not triggered, ensure your testing invoices have a 0 "penny" amount.
-Once installed, begin by activating the module from the list of available gateways in '''Setup > Payment Gateways'' and then configure as follows:
+You can also set the Sandbox to always approve, by logging into the Sandbox and navigating to Settings > Sandbox and changing the transaction response to Always Approve.
-#Enter a Display Name of your choice for end users to see (eg. Credit Card)
+===Migrating to the eWay Tokens Module===
-#Enter your eWAY Customer ID, Username & Password
-#Ensure that "Disable Credit Card Storage" is '''un'''ticked in '''Setup > General Settings > Security''' - when using a token module it is not needed
-Note: eWAY operates a separate system for dev/sandbox testing and so you will need to register @ http://eway.com.au/developers/sandbox.html in order to use the demo mode.
+In earlier versions of WHMCS, there were modules for eWay that did not make use of the Transparent Redirect or Tokenised storage mechanisms.  If you are using one of these payment gateway solutions, we encourage you to look at migrating to the newer eWay Tokens module.
+If you are using a payment gateway module named "eway", switching to the current module will require your clients login and enter their credit card payment details manually the first time they receive an invoice following the switch.  This is so that eWay can capture your customers credit card details in order to create a token.
-==Multi-Currency==
+If you are using the payment gateway module named "eway tokens" then the current module can act as a drop-in replacement for that and the existing tokens will be able to be used by the newer module, so recurring billing can continue interupted.
-This module does not send the currency when processing payments, so can currently only be used to process payments in the eWay account balance. IE. if your eWAY account is in AUD, you can only process AUD transactions through WHMCS.
-However orders may still be accepted in other currencies so long as the Setup > Payments > Payment Gateways > Convert to for Processing setting is set to your eWay account currency (to continue the above example, AUD).
+To make the switch, simply activate the new module which you'll find in ''Setup > Payment Gateways'' listed as '''eWay Token Payments''', configure it with your eWay RapidAPI credentials, and then click the deactivate button next to the older module, at which point you'll be prompted to choose a replacement payment gateway for items assigned to that currently, and there you should just select the eWay Token Payments module from the dropdown provided.
+For more information or advice on the various payment gateway solutions eWay offers, you can contact eWay directly via https://www.eway.com.au/contact-us
 {{modules}}

Documentation