Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

eWAY Eway is a payment gateway for credit card payments over a secure connection. It conforms to PSI PCI DSS (Payment Card Industry Data Security Standard). 


CSS The Customer Self Service eCommerce Platform supports the two newer eWAY Rapid current Eway API methods:

  • eWAY Eway Secure Fields eWAY Responsive Shared Page- 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. 


Info

To use the current Eway methods, websites must be on version 4.23+.


The two older (deprecated) methods are also supported:

...

For more information on eWAY's payment solutions, refer to their website.


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

Eway Payment Processing Overview


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

...

. At no point does Commerce Vision handle or see credit card information during the transaction.

  1. The 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. What they see next depends on the method selected for your site:

    For Secure Fields, the credit card form with input fields securely hosted by Eway will be displayed.

    Image Added

    4. They enter their card details and submit their order.

     

    5. Commerce Vision does the preliminary

    setup and checks:for Secure Fields:

    checks to ensure the order is valid for submission and payment information is set up,

    request

    then requests an Access Code for the transaction from

    eWAY

    Eway over a secure connection

    which needs to be posted with the card information
  4. 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

    .

    6. The page (including the credit card information and the Access Code) is submitted directly to

    eWAY

    Eway's servers.

    For


     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.For both methods, eWAY

    is in use, no form is displayed. 

    Image Added

    4. Instead, the user clicks 'Process Payment'.

    5. The system passes the user and order transaction details to eWAY, which generates a popup form for entering card details. This form is entirely hosted by Eway. 

    Image Added

    6. The user enters their card details and submits their order.

    7. For both methods, Eway processes the payment and then redirects the user to

    our

    your site's return page

    , which finalises the order and triggers the appropriate

    . The order is finalised, triggering either the Success or Fail page

    to be displayed

    .

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

...

  1. Image Added


Select an Eway method


When your site uses an Eway method to process credit cards, this the message appears in the 'Payment' panel of the Checkout page under the Credit Card tab . It includes the eWAY method actively used will include the Eway method active on your site.

When setting eWAY up on your site, method your website will be using will have been set upDuring setup, Commerce Vision will configure the selected method for your website. However, note that you can change and configure the method yourself. Note NOTE - if you change methods, the relevant new API key need to be createdgenerated

...

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

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

  3. Click Configure.
     
  4. In Provider Selection, select the eWAY Eway method required.
  5. Click Save or Save and Exit
Tip

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. 

Image Removed

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

Image Removed

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


  1. Ensure the configuration settings are correct. 
     
  2. Click Save or Save and Exit


Info
titleSurcharges

If When using eWAY Eway Responsive Shared Page:

  • any credit card surcharge must be configured in the same way in CSS the "Customer Self Service eCommerce Platform" and in eWAYEway.
  • 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 deprecated 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. 

...

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

      Warning

      The code must be entered in all lowercase letters.


Related Help

Content by Label
showLabelsfalse
showSpacefalse
excludeCurrenttrue
cqllabel = "eway"


Content by Label
showLabelsfalse
showSpacefalse
titleCredit card payments
cqllabel = "credit-card"

...