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 current eWAY Rapid Eway API methods:

  • eWAY Eway Secure Fields -   fields securely hosted by eWAY Eway appear in the form on your website. 
  • eWAY Eway Responsive Shared Page -   an entirely eWAY 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
titleSurcharges

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.

    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.  Commerce Vision never handles or even sees At no point does Commerce Vision handle or see credit card information at any point in the processduring the transaction.

    1. A The site user creates an order and goes through checkout.
    2. They select credit card as their payment option.

    3. What they see next depends on the method used on selected for your site:

      If

      For Secure Fields

      is in use

      , the

      user will see the

      credit card form with input fields securely hosted by

      eWAY

      Eway will be displayed.

      Image Modified

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

      5. Commerce Vision does the preliminary

      setup and

      checks

      to ensure

      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.

      6.

      We post/submit the

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

      eWAY

      Eway's servers.

       If


       For Responsive Shared Page is in use, no form is displayed. 

      Image Modified

      4. Instead,

      when

      the

      buyer

      user clicks 'Process Payment'

      , the

      .

      5. The system passes the user and order transaction details to eWAY

      to generate a Responsive Shared Page URL with

      , which generates a popup form for entering card

      information

      details.

       This

      This form is entirely hosted by

      eWAY

      Eway

      Image Modified

      5. They enter

      6. The user enters their card details and

      submit

      submits their order

      .6

      .

       We request the results from eWAY using the Access Code.

      7. For both methods,

      eWAY

      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

      .

      Image Modified

    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

    ...


    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, CV Support will configure method selected During 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 enabled, toggle on ON Payment Provider.

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

    5. Ensure the configuration settings are correct. 
       
    6. 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. 
    Tip
    Info
    titleSurcharges

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

    ...