Linking to eWAY


Recurring Payments

A recurring payment schedule allows you to setup customers' for automatic billing on a daily, weekly, fortnightly or monthly basis.

eWAY fields Sent Maximum Field Length (Characters) Required Fields
ewayCustomerID 8 Included
CustomerRef 20
CustomerTitle 20  
CustomerFirstName 50 Included
CustomerLastName 50 Included
CustomerCompany 100  
CustomerJobDesc 50  
CustomerEmail 50  
CustomerAddress 255  
CustomerSuburb 50  
CustomerState 50 Included
CustomerPostCode 6 Included
CustomerCountry 50 Included
CustomerPhone1 20
CustomerPhone2 20
CustomerFax 20
CustomerURL 255
CustomerComments 255
RebillInvRef 255
RebillInvDesc 255
RebillCCName 50 Included
RebillCCNumber 19 Included
RebillCCExpMonth 2 Included
RebillCCExpYear 4 Included
RebillInitAmt 10 Included
RebillInitDate 10 Included
RebillRecurAmt 10 Included
RebillStartDate 10 Included
RebillInterval 2 Included
RebillIntervalType 1 Included
RebillEndDate 10 Included
eWAY Fields Returned Maximum Field Length (Characters) Required Fields
Result 6 Included
ErrorSeverity 16 Included (If Not Successful)
ErrorDetails 255 Included (If Not Successful)
eWAY field Name Description
ewayCustomerID Your unique eWAY customer ID assigned to you when you join eWAY. eg 11438715
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.

 

The following is an example of the XML sent to the eWAY XML reBILL page;

 

The following is an example of the XML returned after a successful reBILL Upload;

 

The following is an example of the XML returned after a Failed reBILL Upload;

Webservice

The following methods are available through the reBill Web Service:

For reBill Customer operations:
  • Create Rebill Customer
  • Update rebill Customer
  • Query Rebill Customer
  • Delete Rebill Customer
For reBill Event operations:
  • Create Rebill Event
  • Update Rebill Event
  • Query Rebill Event
  • Delete Rebill Event
For rebill Transaction operations:
  • Query Next Transaction
  • Query Transactions

Download the reBill Web Service field definitions and instructions

Bookmark and Share