The Batch Result File XML Specification
The Batch Result File XML Specification
This section describes the contents of the batch file downloadable by using iVeriClient FileTransfer with Command “Batch” and the “XML” switch set to true (refer to the iVeri Client Developers Guide documentation (available from the iVeri website) for further details of this command). This file can also be downloaded from the iVeri BackOffice (refer to the “iVeri BackOffice User Guide” (available from the iVeri website) for more details).
The Batch Result File has the following XML tags :
<V_XML Version="2.0" Direction="Response">
<Batch Command="BatchDownload" Count="" Amount="">
<Date></Date>
<Filename></Filename>
<BatchItem ApplicationID="" Mode="" Command="" RequestID="">
<Terminal></Terminal>
<MerchantReference></MerchantReference>
<ResultStatusCode></ResultStatusCode>
<PurchaseDate></PurchaseDate>
<PurchaseTime></PurchaseTime>
<Amount></Amount>
<CCNumber></CCNumber>
<AuthorisationCode></AuthorisationCode>
<TransactionIndex></TransactionIndex>
<Acquirer></Acquirer>
<AcquirerReference></AcquirerReference>
<AcquirerDate></AcquirerDate>
<AcquirerTime></AcquirerTime>
<ReconStatus></ReconStatus>
<ReconReference></ReconReference>
</BatchItem>
</Batch>
</V_XML>
Tag multiplicity:
- The <Batch> element can occur only once
- The <BatchItem> element can occur multiple times under the <Batch> element
<Batch> attributes
|
TAG
NAME
|
|
DESCRIPTION
|
|
Data
Type
|
Length
|
Format
/ Range
|
|
|
Amount
|
|
The sum of the Amount sub-element
values of all the BatchItem
sub-elements
|
|
Numeric
|
<=12
|
|
|
|
Count
|
|
The number of BatchItem
sub-elements
|
|
Numeric
|
<=6
|
|
|
<Batch> sub-elements
|
TAG
NAME
|
|
DESCRIPTION
|
|
Data
Type
|
Length
|
Format
/ Range
|
|
|
Date
|
|
The Date for the corresponding
batch specified in the Batch Upload File
|
|
Numeric
|
8
|
yyyymmdd
|
|
|
Filename
|
|
The Filename for the corresponding
batch specified in the Batch Upload File
|
|
Text
|
<=64
|
|
|
|
BatchItem
|
|
An element for each transaction in
this batch
|
|
XML element
|
|
|
|
<BatchItem> attributes
|
TAG
NAME
|
|
DESCRIPTION
|
|
Data
Type
|
Length
|
Format
/ Range
|
|
|
ApplicationID
|
|
The ApplicationID specified for the
corresponding transaction in the Batch Upload File (all BatchItem elements
under a Batch element have the same ApplicationID)
|
|
GUID
|
38
|
{00000000-0000-0000-0000-000000000000}
|
|
|
Mode
|
|
The Mode of the ApplicationID
|
|
Text
|
4
|
“Test”, “Live”
|
|
|
Command
|
|
The transaction type
|
|
Text
|
<=64
|
“Authorisation”,
“AuthorisationReversal”, “Debit” (Sale), “Credit” (Refund)
|
|
|
RequestID
|
|
A unique identifier for the
transaction allocated by iVeri
|
|
GUID
|
38
|
{00000000-0000-0000-0000-000000000000}
|
|
<BatchItem> sub-elements
|
TAG
NAME
|
|
DESCRIPTION
|
|
Data
Type
|
Length
|
Format
/ Range
|
|
|
PurchaseDate
|
|
The
transaction time reference (if any) specified in the request
|
|
Numeric
|
8
|
yyyymmdd
|
|
|
PurchaseTime
|
|
The transaction time reference (if
any) specified in the request
|
|
Numeric
|
6
|
hhmmss
|
|
|
TransactionIndex
|
|
The sequence identifier of this
transaction allocated by iVeri to be used with follow-up transactions (eg.
refund of a sale)
|
|
GUID
|
38
|
{00000000-0000-0000-0000-000000000000}
|
|
|
MerchantReference
|
|
The general purpose reference for
this transaction (normally an invoice number) specified in the request
|
|
Text
|
<=64
|
|
|
|
Terminal
|
|
An identifier for grouping of
transactions
|
|
Alpha Numeric
|
<=8
|
|
|
|
CCNumber
|
|
The card number specified in the
request
|
|
Numeric
|
<=20
|
|
|
|
Amount
|
|
The transaction value in the
Currency minor unit (ie. no decimal point)
|
|
Numeric
|
<=12
|
|
|
|
AuthorisationCode
|
|
The authorisation code (if any)
either specified in the request or responded by the Acquirer
|
|
Alpha Numeric
|
<=9
|
|
|
|
Acquirer
|
|
The name of the acquirer which
processed the transaction
|
|
Text
|
<=32
|
|
|
|
AcquirerDate
|
|
The transaction processing date
responded by the Acquirer
|
|
Numeric
|
8
|
yyyyymmdd
|
|
|
AcquirerTime
|
|
The transaction processing time
responded by the Acquirer
|
|
Numeric
|
6
|
hhmmss
|
|
|
AcquirerReference
|
|
Consists of a Cycle and Trace with
at least the Trace known to the Acquirer
|
|
Text
|
<=64
|
Cycle:Trace
|
|
|
ReconReference
|
|
A reference, either extracted from
the MerchantReference or generated by iVeri, which can be used when
reconciling with some of the acquirers
|
|
Numeric
|
<=8
|
|
|
|
ReconStatus
|
|
The result of the reconciliation
process within the iVeri system
|
|
Integer
|
|
See Appendix A
|
|
|
ResultStatusCode
|
|
The result of processing this
transaction - the result code multiplied with the result status. See
Appendix A for details.
|
|
XML element
|
|
|
|