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

Compare with Current View Page History

« Previous Version 13 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).


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

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, to:
    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 versions:

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


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.

      The code must be entered in all lowercase letters.


Need assistance implementing this feature

Please contact Commerce Vision for assistance implementing this functionality.


Related help



  • No labels