eWAY is a payment gateway for credit card payments over a secure connection. It conforms to PSI DSS (Payment Card Industry Data Security Standard).
CSS supports the current eWAY Rapid API methods:
- eWAY Secure Fields - fields securely hosted by eWAY appear in the form on your website.
- eWAY Responsive Shared Page - an entirely eWAY hosted payment popup form for the customer to enter their card details so the payment process is removed from your site altogether. If credit card fees are charged on orders for your site, Responsive Shared Page is recommended.
The two older (deprecated) methods are also supported:
- Rapid API Version 3
- Rapid API Version 1.1
For more information on eWAY's payment solutions, refer to their website.
- This guide assumes that eWAY's services have been purchased and you have the relevant information required to set up eWAY.
- You need to have created an API key in your eWAY Business Centre interface. See: Generating an API Key for eWAY.
- CV Support is required to implement this functionality.
eWAY Payment Processing Overview
Credit card payment using eWAY is processed through the following steps. Commerce Vision never handles or even sees credit card information at any point in the process.
- A site user creates an order and goes through checkout.
They select credit card as their payment option.
What they see depends on the method used on your site:
If Secure Fields is in use, the user will see the credit card form with input fields securely hosted by eWAY.
4. They enter their card details and submit their order.
5. Commerce Vision does the preliminary setup and checks to ensure the order is valid for submission and payment information is set up, request an Access Code for the transaction from eWAY over a secure connection.
6. We post/submit the page (including the credit card information and the Access Code) directly to eWAY's servers.
If Responsive Shared Page is in use, no form is displayed.
4. Instead, when the buyer clicks 'Process Payment', the system passes the user and transaction details to eWAY to generate a Responsive Shared Page URL with a popup form for entering card information. This form is entirely hosted by eWAY.
5. They enter their card details and submit their order.
6. We request the results from eWAY using the Access Code.
7. For both methods, eWAY processes the payment and then redirects the user to our return page, which finalises the order and triggers the appropriate Success or Fail page to be displayed.
Selecting an eWAY method
If your site uses eWAY to process credit cards, this message appears in the 'Payment' panel of the Checkout page under the Credit Card tab. It includes the eWAY method active on your site.
When setting eWAY up on your site, CV Support will configure method selected for your website. However, note that you can change the method yourself. Note - if you change methods, the relevant new API key need to be created.
- In the CMS, navigate to Settings → Feature Management → Payment & Checkout.
- If not enabled, toggle on Payment Provider.
- Click Configure.
- In Provider Selection, select the eWAY method required.
- Click Save or Save and Exit.
You can also select the payment option in Settings → Settings → Orders → Credit Cards. In the 'C/Card Payment Provider' field, select the eWAY method required.
Surcharges
When using eWAY Responsive Shared Page:
- any credit card surcharge must be configured in the same way in CSS and in eWAY.
- surcharge is calculated based on the card type entered by the user.
- some surcharge options that are available when using the other methods are not available i.e. applying a surcharge based on the Customer, or the order amount total excluding charges.
Deprecated methods
Both these methods use eWAY's Transparent Redirect solution. They are deprecated but are still available in the CSS.
Rapid API Version 3
- For Rapid API Version 3.0, you need to have created an API key in your eWAY Business Centre interface. See: Generating an API Key for eWAY.
Rapid API Version 1.1
- This is the earliest Transparent Redirect solution.
To setup eWay Rapid API Version 1.1:
- Login as an Administrator
- Go to the Settings page
- Select the Orders tab
- Select the Credit Cards sub-tab
- Configure the following settings:
- C/Card Payment Provider: select eway rapid api
- Credit Card Capture Customer ID: enter your Customer ID (provided by eWAY)
- Retain Payment Provider Customer ID Token: check the box for customers to be able to choose whether their information will be stored in eWAY and be available in future payments checks
eWay Billing Country: enter the relevant 2 letter country code, e.g., 'au' for Australia, 'nz' for New Zealand. A full list of available codes can be found here.
The code must be entered in all lowercase letters.
Related Help
