Open the Portico Developer Guide site
PosGateway Schema
Header Element
PosGateway Schema > PosReportBatchDetailRspType Complex Type : Header Element
Description

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

Namespace http://Hps.Exchange.PosGateway
Diagram
HostBatchTxnAmt Element HostBatchTxnCnt Element HostBatchNbr Element BatchTxnAmt Element BatchTxnCnt Element CloseTxnId Element OpenTxnId Element CloseUtcDT Element OpenUtcDT Element BatchSeqNbr Element BatchStatus Element BatchId Element DeviceId Element MerchName Element SiteId Element All Header Element
Overview
Header

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

All
SiteId xs:int
MerchName xs:string

Merchant name associated with this site id

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

HostBatchNbr optional xs:int

Host batch number.

HostBatchTxnCnt optional xs:int

Total number of transactions in the host batch.

HostBatchTxnAmt optional xs:decimal

Sum of transaction amounts in the host batch.

Source
<xs:element name="Header" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <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="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" />
      <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="HostBatchNbr" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Host batch number.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostBatchTxnCnt" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Total number of transactions in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostBatchTxnAmt" type="xs:decimal" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of transaction amounts in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:all>
  </xs:complexType>
</xs:element>
See Also
PosReportBatchDetailRspType Complex TypePosGateway Schema