|
Input Fields
|
Required
|
Character Limits/Required Input
|
Description
|
|
reference
|
Y
|
50 char
|
The merchant’s reference for this transaction
|
|
totalAmount
|
Y
|
10 num
|
The amount of the transaction in the lowest denomination for the currency.
Example:
[1] For AUD, NZD, USD etc. These currencies have a decimal part: a $27.00 AUD transaction would have a TotalAmount = '2700'
[2] For VND, JPY, KRW etc. These currencies DO NOT have a decimal part: a 27 VND transaction would have TotalAmount = '27'
Reference Currency list - ISO 4127 Standard
The value of this field must be 0 for the CreateTokenCustomer and UpdateTokenCustomer methods
|
|
currencyCode
|
N
|
3 char
|
The ISO 4217 3 character code that represents the currency that this transaction is to be processed in. If no value for this field is provided, the merchant's default currency is used. This should be in uppercase.
e.g. Australian Dollars = AUD
|
|
billingTitle
|
N
|
5 char
|
The customer's title, empty string allowed.
One of: Mr., Ms., Mrs., Miss, Dr., Sir., Prof.
|
|
billingFirstName
|
N
|
50 char
|
The customer's first name
|
|
billingLastName
|
N
|
50 char
|
The customer’s last name
|
|
billingStreet1
|
N
|
50 char
|
The customer’s street address
|
|
billingStreet2
|
N
|
50 char
|
The customer’s street address
|
|
billingCity
|
N
|
50 char
|
The customer’s city/town/suburb
|
|
billingState
|
N
|
50 char
|
The customer’s state/country
|
|
billingPostalCode
|
N
|
30 char
|
The customer’s post/zip code
|
|
billingCountry
|
N
|
2 char
|
The customer's country. This should be the two letter ISO 3166-1 alpha-2 code. This field must be lower case.
e.g. Australia = au
|
|
billingPhone
|
N
|
32 char
|
The customer’s phone number
|
|
billingMobile
|
N
|
32 char
|
The customer’s mobile phone number
|
|
billingEmail
|
N
|
50 char
|
The email address of the person the order is shipped to, which must be correctly formatted if present.
|
|
cardName
|
N
|
50 char
|
The name of the card holder
|
|
shippingMethod
|
N
|
30 char
|
The method used to ship the customer's order
One of: Unknown, LowCost, DesignatedByCustomer, International, Military, NextDay, StorePickup, TwoDayService, ThreeDayService, Other
|
|
shippingFirstName
|
N
|
50 char
|
The first name of the person the order is shipped to
|
|
shippingLastName
|
N
|
50 char
|
last name of the person the order is shipped to
|
|
shippingStreet1
|
N
|
50 char
|
The street address the order is shipped to
|
|
shippingStreet2
|
N
|
50 char
|
The street address of the shipping location
|
|
shippingCity
|
N
|
50 char
|
The city / suburb of the shipping location
|
|
shippingState
|
N
|
50 char
|
The state / county of the shipping location
|
|
shippingCountry
|
N
|
2 char
|
The country of the shipping location. This should be the two letter ISO 3166-1 alpha-2 code. This field must be lower case.
e.g. Australia = au
|
|
shippingPostalCode
|
N
|
30 char
|
The post / zip code of the shipping location
|
|
shippingPhone
|
N
|
32 char
|
The phone number of the person the order is shipped to
|
|
invoiceNumber
|
N
|
64 char
|
The merchant's invoice number for this transaction
|
|
invoiceDescription
|
N
|
64 char
|
A description of the purchase that the customer is making
|
|
invoiceReference
|
N
|
50 char
|
The merchant's reference number for this transaction
|
|
method
|
Y
|
ProcessPayment, Authorise, TokenPayment, CreateTokenCustomer, UpdateTokenCustomer
|
The type of transaction being performed. One of the following values – ProcessPayment, Authorise, TokenPayment, CreateTokenCustomer, UpdateTokenCustomer
|
|
partnerId
|
N
|
50 char
|
The partner ID generated from an eWAY partner agreement.
|
|
transactionType
|
Y
|
20 char
|
The type of transaction you're performing
One of: Purchase, MOTO, Recurring
|
