Open the Portico Developer Guide site
PosGateway Schema
PosReportBatchHistoryRspType Complex Type
PosGateway Schema : PosReportBatchHistoryRspType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
Details Element Header Element Sequence PosReportBatchHistoryRspType Complex Type
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

Used By
ReportBatchHistory Element
Source
<xs:complexType name="PosReportBatchHistoryRspType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element name="Header">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Report header that can include general information related to the details, criteria used for the report, totals, etc.</p>
        </xs:documentation>
      </xs:annotation>
      <xs:complexType>
        <xs:all>
          <xs:element name="RptStartUtcDT" type="xs:dateTime">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Start date time of report results in UTC (Coordinated Universal Time)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="RptEndUtcDT" type="xs:dateTime">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">End date time of report results in UTC (Coordinated Universal Time)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="SiteId" type="xs:int" />
          <xs:element name="MerchName" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Merchant name associated with this site id</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="DeviceId" type="xs:int" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Device identifier of report results, if not present results are for all devices associated with the site</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="BatchCnt" type="xs:int">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Number of batches</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="BatchAmt" type="xs:decimal">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Sum of all batch amounts</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:all>
      </xs:complexType>
    </xs:element>
    <xs:element name="Details" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Report details, sorted by DeviceId, OpenUtcDT</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> 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.
            </p>
        </xs:documentation>
      </xs:annotation>
      <xs:complexType>
        <xs:all>
          <xs:element name="DeviceId" type="xs:int" />
          <xs:element name="BatchId" type="xs:int" />
          <xs:element name="BatchStatus" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The batch status at the time of the report.</p>
                <p xmlns="http://Hps.Exchange.PosGateway">
                    Key batch status values include:
                    <ul><li>'O' (open)</li><li>'C' (closed)</li><li>'E' (error)</li></ul></p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="BatchSeqNbr" type="xs:int" />
          <xs:element name="OpenUtcDT" type="xs:dateTime">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Batch open date time in UTC (Coordinated Universal Time)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CloseUtcDT" type="xs:dateTime" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Batch close date time in UTC (Coordinated Universal Time)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="OpenTxnId" type="txnIdType">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The transaction identifier of the transaction that caused the batch to be opened</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CloseTxnId" type="txnIdType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The transaction identifier of the transaction that caused the batch to be closed</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="BatchTxnCnt" type="xs:int">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Number of transactions in the batch</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="BatchTxnAmt" type="xs:decimal">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Sum of transaction amounts in the batch</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TzConversion" type="tzoneConversionType" default="UTC">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Time zone conversion applied to report results</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="OpenDT" type="xs:dateTime">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Batch open date time in the time zone conversion requested</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CloseDT" type="xs:dateTime" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Batch close date time in the time zone conversion requested</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:all>
      </xs:complexType>
    </xs:element>
  </xs:sequence>
</xs:complexType>
See Also
PosGateway Schema