Configuration settings can be entered for the current eWAY 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.
- 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 the relevant eWAY API key from your eWAY Business Centre interface.
- Commerce Vision is required to implement this functionality. For both the Secure Fields and Responsive Shared Page solutions, please provide the Public API Key. See: Get eWAY API Key.
Step-by-step guide
During setup, Commerce Vision will configure the selected method for your website. However, note that you can change and configure the method yourself. NOTE - if you change methods, the relevant new API key need to be generated.
- 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.
- Ensure the configuration settings are correct.
- Click Save or Save and Exit.
Surcharges
When using eWAY Responsive Shared Page:
- any credit card surcharge must be configured in the same way in the "Customer Self Service eCommerce Platform" 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 deprecated methods use eWAY's Transparent Redirect solution.
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
