Versions Compared

Old Version 16

changes.mady.by.user Documenter

Saved on

compared with

New Version 17

changes.mady.by.user Documenter

Saved on

Key

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

eWAY is a payment gateway for credit card payments over a secure connection. It conforms to PSI DSS (Payment Card Industry Data Security Standard). Various methods provided under eWAY's Rapid API payment solution are supported by CSS.  

...

 


CSS supports four eWAY Rapid API methods:

  • Rapid API Version 1.1
  • Rapid API Version 3
  • eWAY Direct Connection API / secure fields
  • eWAY Responsive Shared Page API

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.
  3. They enter their card details and submit their order. 
  4. Commerce Vision does preliminary setup and checks, tosuch as:
    1. ensure the order is valid for submission
    2. set up payment information
    3. request an Access Code for the transaction from eWAY over a secure connection which needs to be posted with the card information.
  5. Once our checks and set ups are done, we post/submit the page (including the credit card information and the Access Code) on behalf of the user directly to eWAY's servers. Their credit card information goes directly to eWAY. Commerce Vision never handles or even sees the information at any point in the process.
  6. 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.

Step-by-step guide

CSS supports four eWAY Rapid API methods:

  • Rapid API Version 1.1
  • Rapid API Version 3
  • eWAY Direct Connection API / secure fields
  • eWAY Responsive Shared Page API
For more information on eWAY's payment solutions, refer to their website
Warning
Note
  • This guide assumes that eWAY's services have been purchased and you have the relevant information required to set-up eWAY.
  • 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.


When eWAY has been selected 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.

Image Added

Once eWAY has been set up on your site, the eWAY method required can be selected for credit card processing and payment. 

  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 for your site.

  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

Direct Connection API

Direct Connection API involves a simple, single server side call to process a transaction. In CSS, it is implemented with eWAY's Secure Fields. This inserts eWAY hosted secure iframes into the card fields on your website so the customer is kept on your site during the payment process. 

Responsive Shared Page API

This method is an entirely eWAY hosted payment form for the customer to enter their card details. So 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 Added

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

Image Added

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

Image Added

Info
titleSurcharges

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.



Rapid API Version 1.1

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.

      Warning

      The code must be entered in all lowercase letters.

Image Removed

Responsive Shared Page API

...

    1. .

...

Image Removed

Instead, when they click 'Process Payment', they will see a popup box where they enter their credit card information. 

Image Removed

Once payment is processed, the box closes and they will be taken to your site's Order Confirmation page.

...


Note
titleNeed assistance implementing this feature

Please contact Commerce Vision for assistance implementing this functionality.


Related help

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "eway"

...