eWAY API

Stored Payments (Merchant Hosted)

The eWAY Stored Payment (Merchant Hosted) solution allows customers’ payment information to be stored in real time from your website. This method provides the ability to charge customers when necessary through the eWAY Business Centre.

Linking to eWAY

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

eWAY Fields Sent	Maximum Field Length (Characters)	Required Fields
ewayCustomerID	8
ewayTotalAmount	12
ewayCustomerFirstName	50
ewayCustomerLastName	50
ewayCustomerEmail	50
ewayCustomerAddress	255
ewayCustomerPostcode	6
ewayCustomerInvoiceDescription	255
ewayCustomerInvoiceRef	50
ewayCardHoldersName	50
ewayCardNumber	20
ewayCardExpiryMonth	2
ewayCardExpiryYear	2
ewayTrxnNumber	16
ewayOption1	255
ewayOption2	255
ewayOption3	255

eWAY Fields Returned	Maximum Field Length (Characters)	Required Fields
ewayTrxnStatus	6
ewayTrxnNumber	16
ewayTrxnReference	50
ewayTrxnOption1	255
ewayTrxnOption2	255
ewayTrxnOption3	255
ewayAuthCode	6
ewayReturnAmount	12
ewayTrxnError	100

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.
ewayTrxnReference	See 'eWAYTrxnNumber'.
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.
ewayTrxnNumber	This value is returned to your website. You can pass a unique transaction number from your site. You can update and track the status of a transaction when eWAY returns to your site. NB. This number is returned as 'ewayTrxnReference'. The number returned as 'ewayTrxnNumber', is actually the unique eWAY Transaction number, created by eWAY itself.
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.
ewayTxnError	This is the response returned by the bank, and can be related to both successful and failed transactions.

Example XML Layout

Please do not copy/paste the following XML example for your code as it is presented here for display purposes only. Please refer to our source code for more information.

XML Sent

XML Returned

We have provided sample code for ASP, PHP and ASP.NET (C#) programming languages.

Basically, all you need to do, per transaction, is:

Send the XML document via HTTPS, using SSL.
Parse the XML document returned from eWAY.

ASP Code
- This ZIP file contains the following 3 Active Server Pages:
  
  ePayment.asa - Creates and sends the XML document to eWAY.
  
  paymentForm.htm - An example of a form to send to the process.asp page. Be sure to include a valid eWAYCustomerID when you go live, this will be issued to you after you join eWAY.
  
  process.asp - This includes the ePayment.asa file and displays the transaction results.
  
  For more information on passing XML, please see the Field specifications tab.
  
  Download the XML ASP sample code
PHP Code
- This ZIP file contains the following two files:
  
  EPayment.php - PHP class which you can call from your own PHP code to process a transaction.
  
  testform.php - Sample code to process a test transaction. Show the main functions that you will probably need to call.
  For more information on passing XML, please the Field specifications tab.
  
  Download the PHP sample code
C# Code
- This ZIP file contains several C#.NET Pages and should be added to a Visual Studio Project:
  
  WebForm1.aspx - An example of a form to send to the eWAY gateway. Be sure to include a valid eWAYCustomerID when you go live. This ID will be issued to you once you've joined eWAY.
  
  WebForm1.aspx.cs - C# Server-side code for the WebForm1.aspx page.
  
  GatewayConnector.cs - This page connects to the eWAY gateway, sends an XML request and receives the XML response.
  
  GatewayRequest.cs - This takes the fields from the WebForm1.aspx page, and converts it to an XML string to pass to the GatewayConnector.cs page.
  
  GatewayResponse.cs - This passes the eWAY Gateway response back to the WebForm1.aspx page.
  
  web.config - This holds the configuration settings for the live and test gateway URLs, as well as your eWAY Customer ID and the ID used for testing.
  
  For more information on passing XML, please see the Field specifications tab.
  
  » Download the C# source code

There is currently no test account for this facility. Transactions are not processed immediately with this facility, so to test its functionality you should use the Live gateway. Transactions can then be deleted through your eWAY Business Centre . Stored transactions incur no fee until they are processed.

The Live gateway address is: https://www.eway.com.au/gateway/xmlstored.asp