Open the Portico Developer Guide site
PosGateway Schema
ReportBatchHistory Element
PosGateway Schema > PosResponse Element > Ver1.0 Element > Transaction Element : ReportBatchHistory Element
Namespace http://Hps.Exchange.PosGateway
Type
PosReportBatchHistoryRspType Complex Type
Diagram
Details Element Header Element Sequence ReportBatchHistory Element
Overview
Sequence
Header

Report header that can include general information related to the details, criteria used for the report, totals, etc.

All
RptStartUtcDT xs:dateTime

Start date time of report results in UTC (Coordinated Universal Time)

RptEndUtcDT xs:dateTime

End date time of report results in UTC (Coordinated Universal Time)

SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

DeviceId optional xs:int

Device identifier of report results, if not present results are for all devices associated with the site

BatchCnt xs:int

Number of batches

BatchAmt xs:decimal

Sum of all batch amounts

Details 0..∞

Report details, sorted by DeviceId, OpenUtcDT

Note: If the data was defined in the request or response, a description has not been added here; only fields that are being introduced in this response have additional detail added. Typically, these will be fields that drive business logic that can be assumed at the time of the transaction or they are calculated at the time of the report.

All
DeviceId xs:int
BatchId xs:int
BatchStatus xs:string

The batch status at the time of the report.

Key batch status values include:

  • 'O' (open)
  • 'C' (closed)
  • 'E' (error)

OpenUtcDT xs:dateTime

Batch open date time in UTC (Coordinated Universal Time)

CloseUtcDT optional xs:dateTime

Batch close date time in UTC (Coordinated Universal Time)

OpenTxnId txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be opened

CloseTxnId optional txnIdType Simple Type

The transaction identifier of the transaction that caused the batch to be closed

BatchTxnCnt xs:int

Number of transactions in the batch

BatchTxnAmt xs:decimal

Sum of transaction amounts in the batch

TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

OpenDT xs:dateTime

Batch open date time in the time zone conversion requested

CloseDT optional xs:dateTime

Batch close date time in the time zone conversion requested

Source
<xs:element name="ReportBatchHistory" type="PosReportBatchHistoryRspType" xmlns:xs="http://www.w3.org/2001/XMLSchema" />
See Also
Transaction ElementVer1.0 ElementPosResponse ElementPosGateway Schema