You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Next »

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 two newer eWAY Rapid API methods:

  • eWAY Secure Fields
  • eWAY Responsive Shared Page

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.


Payment Processing Overview


Credit card payment using eWAY is processed through the following steps:

  1. A site user creates an order and goes through checkout.
  2. They select credit card as their payment option and will be presented with credit card input fields. If Secure Fields is in use, then fields securely hosted by eWAY appear in the form. If Responsive Shared Page is used, then customers will be redirected to a form entirely hosted by eWAY. 
  3. They enter their card details and submit their order. 
  4. Commerce Vision does the preliminary setup and checks:
    1. for Secure Fields: 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 which needs to be posted with the card information
    2. for Responsive Shared: pass the customer and transaction details to eWAY to generate a Responsive Shared Page URL, redirect the customer to the URL to enter payment information
  5. For Secure Fields, we post/submit the page (including the credit card information and the Access Code) directly to eWAY's servers. For Responsive Shared Page, we request the results from eWAY using the Access Code. Commerce Vision never handles or even sees credit card information at any point in the process.
  6. 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.

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

Step-by-step guide

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 actively used on your site.

When setting eWAY up on your site, method your website will be using will have been set up. However, note that you can change the method yourself. Note - if you change methods, the relevant new API key need to be created. 

  1. In the CMS, navigate to Settings → Feature Management → Payment & Checkout.

  2. If not already on, toggle Payment Provider on.

  3. Click Configure.
     
  4. In Provider Selection, select the eWAY method required.

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

eWAY methods

Secure Fields

Secure Fields involve a simple, single server side call to process a transaction. Secure fields hosted by eWAY appear in the form.  

Responsive Shared Page

Responsive Shared Page is an entirely eWAY hosted payment form for the customer to enter their card details where the payment process is removed from your site altogether. If this method is active on your site, there are no credit card fields in the Payment panel of the Checkout page. 

Instead, when the buyer clicks 'Process Payment', they will see a popup form from eWAY for entering credit card information. 

Once payment is processed, the form closes and the buyer will be redirected to your site's Order Confirmation page.

Surcharges

If 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 in the eWAY IFrame and the amount sent to the eWAY IFrame.
  • 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

Rapid API Version 1.1

  • This is the earliest Transparent Redirect solution. 

To setup eWay Rapid API Version 1.1:

  1. Login as an Administrator
  2. Go to the Settings page
  3. Select the Orders tab
  4. Select the Credit Cards sub-tab
  5. Configure the following settings:
    1. C/Card Payment Provider: select eway rapid api
    2. Credit Card Capture Customer ID: enter your Customer ID (provided by eWAY)
    3. 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  

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


Credit card payments






  • No labels

© Copyright 2001-2023 Commerce Vision Pty Ltd. Use of this site signifies your acceptance of Commerce Vision’s Terms & Conditions. CV Connect, the Commerce Vision logos, and other Commerce Vision marks are assets of Commerce Vision Pty Ltd.