imgproductsuk_rapidapi3-1

All-in-One API Integration

Combining all the most popular payment solutions in a single package, eWAY’s Rapid 3.1 API also includes fraud prevention, transparent redirect, and direct connection to help developers create secure, perfectly rendered payment pages on all devices.

API SNIPPETS

Sandbox

Create and test a powerful and robust integration using our free Sandbox test account. As an eWAY Merchant or Partner, you have access to a free Sandbox test account that allows you to process transactions and receive real-time responses without the bank connection. The Sandbox can be used to demonstrate the payment gateway, receiving real-time responses and transaction results.

This functionality testing-ground also gives you the chance to assess and streamline what you've built.

Sandbox supports testing for our payment solutions across all APIs and technologies - the requests and responses are the same as the live eWAY gateway. You can test the gateway with Sandbox regardless of what you use to build your sites.

Ready to launch? Switch over to the live endpoints and live API credentials and your system is ready to make lots of money!

Direct Payments

The Direct Connection API allows for purchases to be submitted directly to eWAY from your server. This allows processing of transactions in one, simple server side call.

Since card data is passed via your server, one of the following must be used to ensure compliance with card data regulations:

  • Provide proof to eWAY of PCI-DSS compliance of the merchant's technical environment
  • Use Client Side Encryption to encrypt the card data on the customer's browser (eWAY can help you with this).

Transactions not involving credit card data (such as a recurring token payments) can be processed without proof of compliance.

Please note that Direct Connection is not compatible with 3D Secure, PayPal or MasterPass - to use these features please use Transparent Redirect or the Responsive Shared Page.

Simple JSON REST Example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction

	Data:
	{
	"Customer": {
	   "CardDetails": {
		"Name": "Card Holder Name",
		"Number": "4444333322221111",
		"ExpiryMonth": "12",
		"ExpiryYear": "16",
		"CVN": "123"
	   }
	},
	"Payment": {
	   "TotalAmount": 100
	},
	"TransactionType": "Purchase",
	"Method": "ProcessPayment"
	}
		
		

For more details, check out the documentation Direct Connection documentation

Transparent Redirect

If you want the superior user experience of keeping customers on your website as well as the security of keeping card data off your own systems, eWAY's Transparent Redirect is the way to go.

Transparent Redirect also provides simple and fast integration with 3D Secure, PayPal, MasterPass and Visa Checkout - providing more options for customers and less headaches for development.

Since the payment form is displayed on the site, it is important that an SSL is used to secure the page and provide reassurance to customers, inevitably increasing your basket conversion.

Implementing Transparent Redirect is a three step process:

  1. Pass the customer and transaction details to eWAY to generate an Access Code.
  2. Display a payment form on your site using the Access Code and URL provided by eWAY - this form submits directly to eWAY secure servers. After processing the transaction, the customer is directed (transparently!) straight back to the nominated Redirect URL.
  3. Once the transaction has been processed, request the results from eWAY using the Access Code.
Simple JSON REST example
  1. Request an Access Code

    Endpoint: https://api.sandbox.ewaypayments.com/AccessCodes

    	Data:
    	{
    	"Payment": {
    	   "TotalAmount": 100
    	},
    		"RedirectUrl": "http://www.example.org",
    		"Method": "ProcessPayment",
    		"TransactionType": "Purchase"
    	}
    				
    				
  2. Display the payment form on your site
    	Data:					
    	<form method="POST" action="https://secure-au.sandbox.ewaypayments.com/AccessCode/nvt0mwZXN9aU43rsIRPl...">
    	  <input type="hidden" name="EWAY_ACCESSCODE" value="nvt0mwZXN9aU43rsIRPl..." />
    	  <input type="hidden" name="EWAY_PAYMENTTYPE" value="Credit Card" />
    	  Card Name: <input type="text" name="EWAY_CARDNAME" />
    	  Card Number: <input type="text" name="EWAY_CARDNUMBER" />
    	  Card Expiry: <input type="text" name="EWAY_CARDEXPIRYMONTH" /> / <input type="text" name="EWAY_CARDEXPIRYYEAR"/>
    	  Card CVN: <input type="text" name="EWAY_CARDCVN" />
    	  <input type="submit" value="Process" text="Process" />
    	</form>
    				
  3. Request the result

    Endpoint: https://api.sandbox.ewaypayments.com/AccessCode/nvt0mwZXN9aU43rsIRPl...

Responsive Shared Page

For a simple, good looking integration, eWAY's Responsive Shared Page API provides a hosted form for entering payment information. The form is hosted on eWAY's PCI DSS compliant, industry leading infrastructure for your and your customer's peace of mind. There are a number of themes to customise the look of the form, plus it responds to screen size to be suitable for devices from mobiles to PCs.

The Responsive Shared Page also comes with built in integration with 3D Secure, PayPal, MasterPass and Visa Checkout - no further development required!

Implementing the Responsive Shared Page API is a three step process:

  1. Pass the customer and transaction details to eWAY to generate an Responsive Shared Page URL.
  2. Redirect the customer to the provided URL to enter their payment information. After processing the transaction, the customer is directed back to the nominated Redirect URL.
  3. Once the transaction has been processed, request the results from eWAY using the Access Code.
Simple JSON REST Example
  1. Request an Access Code and Responsive Shared Page URL

    Endpoint: https://api.sandbox.ewaypayments.com/AccessCodesShared

    	Data:
    	{
    		"Payment": {
    			"TotalAmount": 1000
    		},
    		"RedirectUrl": "http://www.example.org/Success.html",
    		"CancelUrl": "http://www.example.org/Cancel.html",
    		"Method": "ProcessPayment",
    		"TransactionType": "Purchase"
    	}
    				
  2. The response will contain a SharedPaymentUrl to redirect the customer to
  3. Once the transaction has been completed, the customer is redirect to your website and you can request the result

    Endpoint: https://api.sandbox.ewaypayments.com/AccessCode/

For more details, check out the Responsive Shared Page documentation

Token Payments

Charge returning customers without re-requesting their billing details! Token Payments allows you to save the details of your customers securely on eWAY's servers and bill them whenever they make new purchases. Capturing and updating a customer's details can be done through any of eWAY's payment APIs, making integration simpler once you are taking payments.

Create a Token

To create a Token Customer, set the "Method" to "CreateTokenCustomer" and the "TotalAmount" to 0.

Simple Direct Connection JSON REST Create Token Example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction

	Data:
	{
	"Customer": {
	   "CardDetails": {
		"Name": "Card Holder Name",
		"Number": "4444333322221111",
		"ExpiryMonth": "12",
		"ExpiryYear": "16",
		"CVN": "123"
	   }
	},
	"Payment": {
	   "TotalAmount": 0
	},
	"Method": "CreateTokenCustomer"
	}
		
Charge a Token

To charge a customer, simply use their TokenCustomerID when submitting the request and set the "Method" to "TokenPayment". Note that if the customer is completing the transaction, a CVN is still required.

Simple Direct Connection JSON REST Charge Token Example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction

	Data:
	{
	"Customer": {
	   "TokenCustomerID": "987654321"
	},
	"Payment": {
	   "TotalAmount": 100
	},
	"TransactionType": "MOTO",
	"Method": "TokenPayment"
	}
		
Update a Token

To update a token customer, just provide the updated details in the request, and set the "Method" to "UpdateTokenCustomer".

Simple Direct Connection JSON REST Update Token Example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction

	Data:
	{
	"Customer": {
	   "CardDetails": {
		"Name": "New Card Holder Name",
		"Number": "5454545454545454",
		"ExpiryMonth": "12",
		"ExpiryYear": "19",
		"CVN": "321"
	   }
	},
	"Payment": {
	   "TotalAmount": 0
	},
	"Method": "UpdateTokenCustomer"
	}
		
Query a Token

To get the details stored for a Token Customer, simple make a request with the Token Customer ID

Simple Query Token Example

Endpoint: https://api.sandbox.ewaypayments.com/Customer/987654321

For more details, check out the Rapid Token documentation

Recurring

Recurring Payments is ideal for subscriptions or installments, allowing you to automatically charge customers on a daily, weekly, fortnightly or monthly basis. The customers details are securely stored on eWAY's servers and can be updated either through the web service or in MYeWAY.

Recurring is accessed via a SOAP web service and requires some different credentials to access: the eWAY Customer ID, username and password.

Create Customer Example

Endpoint: https://www.eway.com.au/gateway/rebill/test/manageRebill_test.asmx

	Data:
	<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:man="http://www.eway.com.au/gateway/rebill/manageRebill">
		<soap:Header>
			<eWAYHeader xmlns="http://www.eway.com.au/gateway/rebill/manageRebill">
				<eWAYCustomerID>87654321</eWAYCustomerID>
				<Username>test@eway.com.au</Username>
				<Password>test</Password>
			</eWAYHeader>
		</soap:Header>
		<soap:Body>
			<CreateRebillCustomer xmlns="http://www.eway.com.au/gateway/rebill/manageRebill">
				<customerTitle>Mr</customerTitle>
				<customerFirstName>Joe</customerFirstName>
				<customerLastName>Bloggs</customerLastName>
				<customerAddress>Bloggs Enterprise</customerAddress>
				<customerSuburb>Capital City</customerSuburb>
				<customerState>ACT</customerState>
				<customerCompany>Bloggs</customerCompany>
				<customerPostCode>2111</customerPostCode>
				<customerCountry>Australia</customerCountry>
				<customerEmail>test@eway.com.au</customerEmail>
				<customerFax>0298989898</customerFax>
				<customerPhone1>0297979797</customerPhone1>
				<customerPhone2/>
				<customerRef>Ref123</customerRef>
				<customerJobDesc/>
				<customerComments>Please Ship ASASP</customerComments>
				<customerURL>https://www.eway.com.au</customerURL>
			</CreateRebillCustomer>
		</soap:Body>
	</soap:Envelope>
		
Create Rebill Event Example

Endpoint: https://www.eway.com.au/gateway/rebill/test/manageRebill_test.asmx

		Data:
	<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
		<soap:Header>
			<eWAYHeader xmlns="http://www.eway.com.au/gateway/rebill/manageRebill">
				<eWAYCustomerID>87654321</eWAYCustomerID>
				<Username>test@eway.com.au</Username>
				<Password>test</Password>
			</eWAYHeader>
		</soap:Header>
		<soap:Body>
			<CreateRebillEvent xmlns="http://www.eway.com.au/gateway/rebill/manageRebill">
				<RebillCustomerID>60000000</RebillCustomerID>
				<RebillInvRef>ref123</RebillInvRef>
				<RebillInvDes>Invoice Description</RebillInvDes>
				<RebillCCName>Card Name</RebillCCName>
				<RebillCCNumber>4444333322221111</RebillCCNumber>
				<RebillCCExpMonth>07</RebillCCExpMonth>
				<RebillCCExpYear>17</RebillCCExpYear>
				<RebillInitAmt>100</RebillInitAmt>
				<RebillInitDate>08/06/2015</RebillInitDate>
				<RebillRecurAmt>100</RebillRecurAmt>
				<RebillStartDate>05/07/2017</RebillStartDate>
				<RebillInterval>1</RebillInterval>
				<RebillIntervalType>1</RebillIntervalType>
				<RebillEndDate>08/12/2017</RebillEndDate>
			</CreateRebillEvent>
		</soap:Body>
	</soap:Envelope>
		

For more details, check out the Recurring documentation

PreAuth

Available only in Australia

eWAY's Pre-authorisation solution allows merchants to reserve funds on a customer's credit card without charging it. They can then confirm the transaction at their convenience via MYeWAY or eWAY's API. This service is perfect for merchants whose prices are dependent on variable costs.

PreAuth is supported by all of eWAY's payment APIs simply by setting the "Method" to "Authorise".

Simple Direct Connection JSON REST PreAuth Example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction

	Data:
	{
	"Customer": {
	   "CardDetails": {
		"Name": "Card Holder Name",
		"Number": "4444333322221111",
		"ExpiryMonth": "12",
		"ExpiryYear": "18",
		"CVN": "123"
	   }
	},
	"Payment": {
	   "TotalAmount": 100
	},
	"TransactionType": "Purchase",
	"Method": "Authorise"
	}
		
Simple Capture JSON REST Example

Endpoint: https://api.sandbox.ewaypayments.com/CapturePayment

	Data:
	{
	  "Payment": {
		"TotalAmount": 10000
	  },
	  "TransactionId": 11111111
	}
		

For more details, check out the Rapid PreAuth documentation

Refunds

You can refund transactions without logging into MYeWAY – refunds can be processed within your own application or system. Simply pass the original transaction ID to the refund gateway along with the amount to be refunded.

Simple Refund JSON Example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction/1234567/Refund

	Data:
	{
	  "Refund": {
		"TotalAmount": 100
	  }
	}
		

For more details, check out the Rapid Refund documentation

Transaction Query

In order to request complete details about a transaction, eWAY's Transaction Query API can be used. This will return details any details about the customer (including any entered in the Responsive Shared Page) along with information about the transaction and any fraud rules that were triggered.

The Transaction Query API is a very simple request with either the Transaction ID or the Access Code for the transaction.

Transaction Query REST example

Endpoint: https://api.sandbox.ewaypayments.com/Transaction/987654321

For more details, check out the Transaction Query documentation

Beagle Fraud Alerts

Beagle Fraud Alerts Enterprise is a real-time alerting system which utilises ReD's world-leading neural network fraud prevention engine to provide superior protection for your business. This protection is built into all eWAY's Rapid payment APIs, making integration a snap.

To ensure Beagle Fraud Alerts Enterprise provides accurate analysis of transactions, it is important to pass as much information as possible. This includes details such as the billing and shipping addresses and the customer's IP address.

If a transaction is flagged as potentially fraudulent, the "ResponseMessage" will contain one or fraud response message codes in addition to the transaction response. This provides the details so that an order can be flagged as potentially fraudulent to the merchant.

Example response message excerpt:

			
	"ResponseMessage": "D4405, F9026",
		

Beagle Lite

Beagle Lite uses GEO-IP rules to block or flag potential fraudulent transactions. Rules are selected within MYeWAY and notifications can be sent via e-mail for any transactions that do not pass the Anti-Fraud rules.

Beagle Lite protection is built into all of eWAY's payment APIs and is available for free with all merchant accounts. In order for a transaction to be processed by Beagle Lite , the following details are required:

  • The customer's billing address
  • The customer's IP
Simple Direct Connection JSON REST example with Beagle Lite fields

Endpoint: https://api.sandbox.ewaypayments.com/Transaction

	Data:
	{
	"Customer": {
		"Title": "Mr.",
		"FirstName": "John",
		"LastName": "Smith",
		"Street1": "Level 5",
		"Street2": "369 Queen Street",
		"City": "Sydney",
		"State": "NSW",
		"PostalCode": "2000",
		"Country": "au",
		"CardDetails": {
				"Name": "Card Holder Name",
				"Number": "4444333322221111",
				"ExpiryMonth": "12",
				"ExpiryYear": "16",
				"CVN": "123"
		}
	},
	"CustomerIP": "93.184.216.34",
	"Payment": {
		"TotalAmount": 100
	},
	"TransactionType": "Purchase",
	"Method": "ProcessPayment"
	}
		

If a transaction is flagged as potentially fraudulent, the "ResponseMessage" will contain the a fraud response message code in addition to the transaction response. This provides the details so that an order can be flagged as potentially fraudulent to the merchant.

Example response message excerpt:

			
	"ResponseMessage": "D4405, F7002",
		

Beagle ID

Beagle ID is an integrated tool allowing you to customise and control the transaction information on your customer's credit card statement, making it easy for them to recognise the payment.

You can choose to display your business name, website details, and/or a transaction reference number against each payment, identifying for customers exactly what they are being charged for and who is charging them.

For NAB users, Beagle ID comes completely free! Although it is only available to NAB merchants at this time, we are working with our partnered banks to provide more options.

3D Secure

3-D Secure provides an additional security measure for customers and merchants. Customers with 3D Secure activated on their credit card will be redirected to a webpage hosted by their bank and asked to enter a PIN, verifying their identity.

3D Secure is integrated directly into eWAY's Transparent Redirect and Responsive Shared Page APIs - these handle the 3D Secure process without requiring any additional development, making integration easy!

Settlement Reports

To get access to settlement details for an eWAY account, the settlement API can be used. This provides summaries of the amounts settled each day, along with details of the transactions that comprise each settlement. This is an excellent resource for systems that need to reconcile payments, such as accounting software.

A request to the settlement API requires a "ReportMode" to determine what details to return - one of SummaryOnly, TransactionOnly or Both. Along with that, a number of other search filters can be applied, such as a date range, card types or currency.

Simple Settlement Reports JSON REST example

https://api.sandbox.ewaypayments.com/Search/Settlement?ReportMode=Both&StartDate=2014-12-01&EdnDate=2014-12-08&Currency=AUD

For more details, check out the Settlement Reports documentation

API Reference:

Sandbox Credentials