Revision as of 18:34, 20 December 2017

Supported Features

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

Contrary to what you might think, you should not tick the setting to "Disable Credit Card Storage" in Setup > General Settings > Security as that will disable entry by a client.

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:

1. Log in to your Partner Portal account
2. Navigate to Resources > Sandbox/Testing and click on 'Request Sandbox'
   1. Note: Skip this step if you already have a Sandbox account
3. Navigate to the Sandbox Login page
4. Go to My Account > User Security > Manage Roles
5. Create role under name of "API KEY"
6. Go to My Account > User Security > Create User
7. Assign "API KEY" role to new user.
8. Choose a name, enter your email address and choose a password.
9. Once the role is created, click ‘actions’ dropdown menu and click "View API Key"
10. 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.

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

Updating Clients' Credit Card Details via the Admin Area

Transferring a local card to remote storage from within the admin area is not currently supported by the eWAY Tokens Module. 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.