Recurring Payments

Recurring Payments is ideal for subscriptions or installments, allowing you to automatically charge customers on a daily, weekly, fortnightly or monthly basis.

Linking to eWAY

The specifications for Recurring Payments are below. To use a web service instead of XML:

Sample code and sandbox testing are available from within MYeWAY, along with many free resources for our registered development partners.

Recurring Payments

To use XML, send the transaction request to https://www.eway.com.au/gateway/rebill/upload.aspx

Transaction request
Field Name Maximum Field Length Required?
eWayCustomerID 8
CustomerRef 20
CustomerTitle 20
CustomerFirstName 50
CustomerLastName 50
CustomerCompany 100
CustomerJobDesc 50
CustomerEmail 50
CustomerAddress 255
CustomerSuburb 50
CustomerState 50
CustomerPostCode 6
CustomerCountry 50
CustomerPhone1 20
CustomerPhone2 20
CustomerFax 20
CustomerURL 255
CustomerComments 255
RebillInvRef 50
RebillInvDesc 255
RebillCCName 50
RebillCCNUmber 19
RebillCCExpMonth 2
RebillExpYear 4
RebillInitAmt 10
RebillInitDate 10
RebillRecurAmt 10
RebillStartDate 10
RebillInterval 2
RebillIntervalType 1
RebillEndDate 10

Sample XML Sent

A recurring schedule must be sent to the gateway in XML format. Although not all fields are listed as required, you must ensure that all tags are included in the XML even if they are empty. The XML must be encoded as UTF-8 to be accepted by the gateway and any special characters must be escaped.

<RebillUpload>
<NewRebill>
  <eWayCustomerID> 87654321 </eWayCustomerID>
  <Customer>
  <CustomerRef>Ref123</CustomerRef>
  <CustomerTitle>Mr</CustomerTitle>
  <CustomerFirstName>Andy</CustomerFirstName>
  <CustomerLastName>Person Test Street</CustomerLastName>
  <CustomerCompany>Acme Corporation</CustomerCompany>
  <CustomerJobDesc>CEO socks</CustomerJobDesc>
  <CustomerEmail>andy.person@acme.com.au - abc</CustomerEmail>
  <CustomerAddress>Mr 123 Test Street Person</CustomerAddress>
  <CustomerSuburb>Capital City</CustomerSuburb>
  <CustomerState>ACT</CustomerState>
  <CustomerPostCode>2345</CustomerPostCode>
  <CustomerCountry>Australia</CustomerCountry>
  <CustomerPhone1>0212345678</CustomerPhone1>
  <CustomerPhone2>0404123456</CustomerPhone2>
  <CustomerFax>0212345679</CustomerFax>
  <CustomerURL>http://www.acme.com.au</CustomerURL>
  <CustomerComments>Please ship ASAP</CustomerComments>
  </Customer>
  <RebillEvent>
  <RebillInvRef>ref123456</RebillInvRef>
  <RebillInvDesc>Acme Recurring Schedule</RebillInvDesc>
  <RebillCCName>Mr Andy Person</RebillCCName>
  <RebillCCNumber>4444333322221111</RebillCCNumber>
  <RebillCCExpMonth>12</RebillCCExpMonth>
  <RebillCCExpYear>15</RebillCCExpYear>
  <RebillInitAmt>2500</RebillInitAmt>
  <RebillInitDate>25/06/2012</RebillInitDate>
  <RebillRecurAmt>2000</RebillRecurAmt>
  <RebillStartDate>25/07/2012</RebillStartDate>
  <RebillInterval>2</RebillInterval>
  <RebillIntervalType>2</RebillIntervalType>
  <RebillEndDate>24/07/2015</RebillEndDate>
  </RebillEvent>
</NewRebill>
</RebillUpload>

Transaction response
Field name Maximum field length Required field
Result 6
ErrorSeverity 16 *
ErrorDetails 255 *
*only returned if the transaction is not successful

Sample XML Received (Valid Transaction)

<ResponseDetails>
  <Result>Success</Result>
</ResponseDetails>

Sample XML Received (Invalid Transaction)

<ResponseDetails>
  <Result>Fail</Result>
  <ErrorSeverity>Error</ErrorSeverity>
  <ErrorDetails>Invalid data type: Credit Card has expired.</ErrorDetails>
</ResponseDetails>

Sent and received
FIELD NAME DESCRIPTION
ewayCustomerID Your unique eWAY customer ID assigned to you when you join eWAY. eg 87654321
CustomerRef Your own reference number for your customer
CustomerTitle Your customers title eg. Mr, Mrs, Miss, Dr, Sir etc.
ewayCustomerFirstName The first name of your customer
ewayCustomerLastName The last name of your customer
CustomerCompany The company your customer works for
CustomerJobDesc Your customers job description/title eg. CEO, Director etc
CustomerEmail Your customers Email address
CustomerAddress Your customers physical address
CustomerSuburb Your customers city/suburb
CustomerState Your customers State
CustomerPostCode Your customers PostCode
CustomerCountry Your customers Country
CustomerPhone1 Your customers Phone Number (Only digit numbers allowed)
CustomerPhone2 Your customers additional phone number (Only digit numbers allowed)
CustomerFax Your customers fax number (Only digit numbers allowed)
CustomerURL The URL of your customers website
CustomerComments Any comments that your customer wishes to add, or you wish to add about the customer
RebillInvRef A reference to your own invoice system for the purchase. This will appear in the Invoice Reference Number field of all transactions in this reBILL event.
RebillInvDesc The description of the products or services purchased. This will appear in the Invoice Description field of all transactions in this reBILL event.
RebillCCName The name on your customer's credit card number
RebillCCNumber Your customer's credit card number
RebillCCExpMonth The expiry month of your customer's credit card. (Must not be an expired credit card).
RebillCCExpYear The expiry year of your customer's credit card. Format must be either (yy or yyyy) eg. 06 or 2006. (Must not be an expired credit card)
RebillInitAmt The initial payment amount of the reBILL event. Enter 0 if initial payment is not required.
RebillInitDate The date of the initial payment of the reBILL event. Enter today's date if no initial payment is required. Format must of dd/mm/yyyy.
RebillRecurAmt The recurring payment amount of the reBILL. The value must be greater than 0.
RebillStartDate The date of the first recurring payment. Format must of dd/mm/yyyy
RebillInterval The size of the interval between recurring payments (used in conjunction with RebillIntervalType). The value must be 1 to 31 only.
RebillIntervalType The type of Interval. (1 = Days, 2 = Weeks, 3 = Months, 4 = Years). The value must be only 1 or 2 or 3 or 4.eg Payments every 3 weeks, enter 3 in the RebillInterval field, and 2 in the RebillIntervalType field.
RebillEndDate The date that recurring payments are to stop. Format must of dd/mm/yyyy. This date must be after RebillStartDate.
Result This returns the status of the reBILL upload. For a successful upload Success is returned, and for a failed upload False is returned.
ErrorSeverity If the upload fails, this will return either Error or Warning. This relates to the XML document passed, but both messages mean that the upload has failed.
ErrorDetails This returns the XML error description.