eWAY API


Shared Payment Solution

The eWAY Shared Payment solution allows your customers’ to be redirected to a secure eWAY payment page via HTTP FORM POST. Customers will enter their credit card details and finalise their payment before being returned to your website.

We provide you with an API, HTML code and testing environment to integrate the eWAY Shared Payment solution.

The gateway URL is: https://www.eway.com.au/gateway/payment.asp


Linking to eWAY

Below are the specifications for using the eWAY Shared Payment solution, including fields sent and returned by the gateway and field descriptions.

eWAY Fields Sent Maximum Field Length (Characters) Required Fields
ewayCustomerID 8 Included
ewayTotalAmount 12 Included
ewayCustomerFirstName 50  
ewayCustomerLastName 50  
ewayCustomerEmail 50  
ewayCustomerAddress 255  
ewayCustomerPostcode 6  
ewayCustomerInvoiceDescription 255  
ewayCustomerInvoiceRef 50  
ewayURL 255  
ewaySiteTitle 255  
ewayTrxnNumber 16  
eWAYoption1 255
eWAYoption2 255
eWAYoption3 255
ewayAutoRedirect 1
eWAY Fields Returned Maximum Field Length (Characters) Required Fields
ewayTrxnStatus 6 Included
ewayTrxnNumber 16 Included
eWAYresponseCode 16 Included
eWAYresponseText 16 Included
ewayTrxnReference 50 Included
eWAYoption1 255 Included
eWAYoption2 255 Included
eWAYoption3 255 Included
eWAYAuthCode 6 Included
eWAYReturnAmount 12 Included
eWAY Field Name Description
ewayCustomerID Your unique eWAY customer ID assigned to you when you join eWAY. eg 11438715
ewayTotalAmount The total amount in cents for the transaction, eg $1.00 = 100
ewayCustomerFirstName The first name of your customer making a purchase at your site.
ewayCustomerLastName The last name of your customer making a purchase at your site.
ewayCustomerEmail The email address of your customer making a purchase at your site.
ewayCustomerAddress The address of your customer making a purchase at your site including state, city and country.
ewayCustomerPostcode The postcode of your customer making a purchase at your site.
ewayCustomerInvoiceDescription A description of the products or services purchased.
ewayCustomerInvoiceRef A reference to your own invoice system for the purchase.
ewayURL The URL of a page on your site. Once the transaction is complete the user can easily return to your site.
ewaySiteTitle The name of your website will be displayed on the Shared Page for the user to see.
ewayAutoRedirect Once a transaction is complete the user is automatically forwarded to the ewayURL, where the results of the transaction can be logged and displayed. Pass "1" to enable, any other value disables this feature.
eWAYresponseCode The status code of a transaction returned from the bank. See response code page for details
eWAYresponseText A text message describing the status of a transactions returned from the bank. See response code page for details
eWAYoption1 This value is returned to your website. An additional field for you to pass and receive information from eWAY.
eWAYoption2 This value is returned to your website. An additional field for you to pass and receive information from eWAY.
eWAYoption3 This value is returned to your website. An additional field for you to pass and receive information from eWAY.
ewayTrxnStatus This value is returned to your website. For a successful transaction "True" is passed and for a failed transaction "False" is passed. This allows you to make your own logging on your website for transaction status.
ewayTrxnReference This value is returned to your website. It contains a unique eWAY transaction number. This number can then be used to query any transaction in the future if required.
eWAYAuthCode If the transaction is successful, this is the bank authorisation number. This is also sent in the email receipt.
eWAYReturnAmount Can be used a check that the transaction is processed for the same amount as you request from your website.

Example HTML

Bookmark and Share