Windcave iPP350 - Message Specification for HIT; Transaction Request and Response

Page 12 of 27
5 Message Specication
This section describes communication aspects of the HIT XML messages specication.
5.1 Transaction
To initiate a transaction the following SCR XML message specied needs to be posted to the HIT POS endpoint.
5.1.1 Transaction Request – Input Parameters
Transaction request elds or properties to initiate a card present transaction with HIT
Property\[Attribute] Required Description
[user] Yes
HIT Username provided by Windcave Alphanumeric, from 1 to 32 charac-
ters in length. Please ensure this is securely congurable via the POS con-
g.
[key] Yes
HIT Key provided by Windcave. Alphanumeric, from 1 to 64 characters in
length. Please ensure this is securely congurable via the POS cong.
Station Yes
Station Id unique to the terminal. Alphanumeric, from 1 to 32 characters.
Please ensure this is securely congurable via the POS cong.
Amount Yes
Amount of transaction in D.CC format. Where D is dollar and C is cent val-
ue. Numeric and decimal point, from 1 to 13 digits.
AmountCash No Amount for cash out. Numeric and decimal point, from 1 to 13 digits.
Cur Yes Currency of the transaction. Alphanumeric, 3 characters only allowed.
TxnType Yes
Transaction Type. Valid values: Purchase, Auth, Refund or Status.
Please note for requesting the Complete transaction after an Auth transac-
tion from the terminal please use our PxPost or WebService API.
TxnRef Yes
Set by POS to uniquely identify transactions. Alphanumeric, from 1 to 40
characters.
DeviceId Yes
HIT POS identier provided by POS. For example, a POS Lane Identier etc.
Alphanumeric, from 1 to 32 characters.
PosName Yes
PosName – agreed between POS Vendor and Windcave. Alphanumeric,
from 1 to 32 characters.
PosVersion No
Version of POS. Supplied by POS to assist transaction recording and diag-
nosis. Alphanumeric, from 1 to 32 characters.
VendorId Yes
The developer of the POS Application. This is agreed between Windcave
and vendor. Alphanumeric from 1 to 32 characters in length.
MRef No
Merchant text eld. Alphanumeric, max 64 characters. Recommend to use,
useful for reporting purposes.
UrlSuccess No
Set the URL to receive a HTTP GET notication on approved card present
payment
UrlFail No
Set the URL to receive a HTTP GET notication on declined card present
payment
Example Transaction Request:
<Scr action="doScrHIT" user="xxx" key="yyy">
<Amount>1.05</Amount>
<Cur>NZD</Cur>
<TxnType>Purchase</TxnType>
<Station>1234567890</Station>
<TxnRef>123</TxnRef>
<DeviceId>Device 1</DeviceId>
<PosName>POS 1</PosName>
<PosVersion>Pos V1</PosVersion>
<VendorId>PXVendor</VendorId>
<MRef>My Reference</MRef>
</Scr>