2. KnowSystem
  3. The Batch Upload File XML Specification

The Batch Upload File XML Specification


The Batch Upload File XML Specification

 
This section describes the contents of the batch file uploadable by using iVeriClient FileTransfer with Command “Batch” (refer to the iVeri Client Developers Guide documentation (available from the iVeri website) for further details of this command). This file can also be uploaded from the iVeri BackOffice (refer to the “iVeri BackOffice User Guide” (available from the iVeri website) for more details).

The Batch Upload File has the following XML tags (see the iVeriClient V_XML documentation for full details on these tags) :

<V_XML Version="2.0" Direction="Request">

            <Batch Version="2.0" Command="BatchUpload" Count="" Amount="">

                        <Date></Date>

                        <Filename></Filename>

                        <Description></Description>

                        <BatchItem ApplicationID="" Mode="" Command="">

                                    <CCNumber></CCNumber>

                                    <Track2></Track2>

                                    <CardSecurityCode></CardSecurityCode>

                                    <StartDate></StartDate>

                                    <ExpiryDate></ExpiryDate>

                                    <BudgetPeriod></BudgetPeriod>

                                    <AuthorisationCode></AuthorisationCode>

                                    <Terminal></Terminal>

                                    <Amount></Amount>

                                    <Currency></Currency>

                                    <MerchantReference></MerchantReference>

                                    <PurchaseDate></PurchaseDate>

                                    <PurchaseTime></PurchaseTime>

                                    <TransactionIndex></TransactionIndex>

                                    <OriginalMerchantReference></OriginalMerchantReference>

                        </BatchItem>

            </Batch>

</V_XML>


 
Tag multiplicity:

  • The <Batch> element can occur multiple times
  • The <BatchItem> element can occur multiple times under a <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 when the batch was created (in which case the batch will be processed on the upload date) or a future date on which the batch should be processed (a past or future date cannot be more than 1 calendar month from the upload date)

Numeric

8

yyyymmdd

Filename

The Filename by which the batch can be identified (must be unique for all batches uploaded for an ApplicationID)

Text

<=64

 

Description

A description for this batch

Text

 

 

BatchItem

An element for each transaction in this batch

XML element

 

 


<BatchItem> attributes

TAG NAME

 

DESCRIPTION

Data Type

Length

Format / Range

ApplicationID

Your ApplicationID allocated by iVeri (the same ApplicationID must be used for all BatchItem elements under a Batch element)

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), “RecurringDebit”


<BatchItem> sub-elements

TAG NAME

DESCRIPTION

Data Type

Length

Format / Range

PurchaseDate

A date reference for this transaction

IMPORTANT NOTE:

This date must be less than or equal to the date on which the batch will actually be processed ie. the date field in the batch sub-element above.

Numeric

8

yyyymmdd

PurchaseTime

A time reference for this transaction

Numeric

6

hhmmss

TransactionIndex

The sequence identifier of a previous transaction (allocated by iVeri) when this transaction is a follow-up (eg. refund of a sale)

GUID

38

{00000000-0000-0000-0000-000000000000}

OriginalMerchantReference

The MerchantReference of a previous transaction done with this ApplicationID when this transaction is a follow-up (redundant when TransactionIndex is specified)

Text

<=64

 

MerchantReference

Your reference for this transaction (must be unique for each BatchItem in a batch for all batches uploaded for an ApplicationID)

Text

<=64

 

Terminal

An identifier for grouping of transactions

Alpha Numeric

<=8

 

CCNumber

The card number

Numeric

<=20

 

Track2

Mag stripe field starting with “;” and ending with “?”

Text

<=40

 

CardSecurityCode

Number printed on the back of the card

Numeric

<=4

 

StartDate

The valid from date of the card

Numeric

6

mmyyyy

ExpiryDate

The expiry date of the card

Numeric

6

mmyyyy

Amount

The transaction value in the Currency minor unit (ie. no decimal point)

Numeric

<=12

 

Currency

The ISO currency code

Alpha

3

 

BudgetPeriod

The period in months if the purchase is on budget

Numeric

<=2

 

AuthorisationCode

The pre-authorisation code if one has been obtained for this transaction

Alpha Numeric

<=9