On This Page

The Batch Element

The
<Batch>
 element is the root of the response file, and it specifies the top level of the response file syntax.
<Batch BatchID=CDATA
       MerchantID=CDATA
       Name=CDATA
       Version=NMTOKEN>
   (ValidationStatus)
   (ValidatedRecords)
   (ValidationTime)
   (ValidationErrors)
</Batch>
The <Batch> element has these attributes:
  • <BatchID>
    —Batch file identifier that you assigned.
    • Data type: Alphanumeric
    • Data length: 8
  • MerchantID
    —Your merchant ID.
    • Data type: Alphanumeric
    • Data length: 30
  • Name
    —Name of the report. This value is always
    OLP Validation Report
    .
    • Data type: Alphanumeric
    • Data length: 25
  • Version
    —Version number of the report. The current version number is
    1.0
    .
    • Data type: Numeric
    • Data length: 10
Attributes of the <Batch> Element
Attribute Name
Attribute Value
BatchID
Batch file identifier that you assigned.
  • Data type: Alphanumeric
  • Data length: 8
MerchantID
Your merchant ID.
  • Data type: Alphanumeric
  • Data length: 30
Name
Name of the report. This value is always
OLP Validation Report
.
  • Data type: Alphanumeric
  • Data length: 25
Version
Version number of the report. The current version number is
1.0
.
  • Data type: Numeric
  • Data length: 10
Child Elements of the <Batch> Element
Element Name
Description
ValidationStatus
Status of the attempted validation. Possible values:
  • Failed
  • Success
  • OnHold
  • ToBeResolved
Specifications:
  • Data type: Alphanumeric
  • Data length: 10
ValidatedRecords
Number of records validated. This value is present only when the validation is successful.
  • Data type: Numeric
  • Data length: 10
ValidationTime
Timestamp for the validation process.
Format: yyyy-MM-ddTHH:mm:ss
  • Data type: DateTime
  • Data length: 25
ValidationErrors
List of the errors in the batch file. This element is present only if the validation failed. See The ValidationErrors Element.
  • Data type: Element