Open the Portico Developer Guide site
PosGateway Schema
Header Element
PosGateway Schema > PosReportBatchSummaryRspType 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
MCSendAmt Element MCSendCnt Element VisaDirectAmt Element VisaDirectCnt Element HostDebitReturnAmt Element HostDebitReturnCnt Element HostDebitSaleAmt Element HostDebitSaleCnt Element HostCreditReturnAmt Element HostCreditReturnCnt Element HostCreditSaleAmt Element HostCreditSaleCnt Element HostTotalAmt Element HostTotalCnt Element HostBatchNbr Element TotalHCPCnt Element TotalSurchargeAmtInfo Element TotalGratuityAmtInfo Element TotalAmt Element TotalCnt Element ReturnAmt Element ReturnCnt Element SaleAmt Element SaleCnt Element DebitAmt Element DebitCnt Element CreditAmt Element CreditCnt 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)

BatchSeqNbr xs:int
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

CreditCnt xs:int

Number of credit transactions in the batch

CreditAmt xs:decimal

Sum of credit transaction amounts in the batch

DebitCnt xs:int

Number of debit transactions in the batch

DebitAmt xs:decimal

Sum of debit transaction amounts in the batch

SaleCnt xs:int

Number of sale transactions in the batch

SaleAmt xs:decimal

Sum of sale transaction amounts in the batch

ReturnCnt xs:int

Number of return transactions in the batch

ReturnAmt xs:decimal

Sum of return transaction amounts in the batch

TotalCnt xs:int

Total number of transactions in the batch

TotalAmt amtTypeGlobal Simple Type

Sum of transaction amounts in the batch

TotalGratuityAmtInfo amtTypeGlobal Simple Type

Sum of gratuity amounts in the batch. Gratuity amounts, if any, are already included in the other amounts.

TotalSurchargeAmtInfo amtTypeGlobal Simple Type

Sum of surcharge amounts in the batch. Surcharge amounts, if any, are already included in the other amounts.

TotalHCPCnt xs:int

Total number of Home Currency Pay transactions in the batch

HostBatchNbr optional xs:int

Host batch number.

HostTotalCnt optional xs:int

Total number of transactions in the host batch.

HostTotalAmt optional xs:decimal

Sum of transaction amounts in the host batch.

HostCreditSaleCnt optional xs:int

Number of credit sale transactions in the host batch.

HostCreditSaleAmt optional xs:decimal

Sum of credit sale transaction amounts in the host batch.

HostCreditReturnCnt optional xs:int

Number of credit return transactions in the host batch.

HostCreditReturnAmt optional xs:decimal

Sum of credit return transaction amounts in the host batch.

HostDebitSaleCnt optional xs:int

Number of debit sale transactions in the host batch.

HostDebitSaleAmt optional xs:decimal

Sum of debit sale transaction amounts in the host batch.

HostDebitReturnCnt optional xs:int

Number of debit return transactions in the host batch.

HostDebitReturnAmt optional xs:decimal

Sum of debit return transaction amounts in the host batch.

VisaDirectCnt xs:int

Number of Visa Direct transactions processed

VisaDirectAmt xs:decimal

Sum of Visa Direct transaction processed

MCSendCnt xs:int

Number of Mastercard Send transactions processed

MCSendAmt xs:decimal

Sum of Mastercard Send transaction processed

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="CreditCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of credit transactions in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="CreditAmt" type="xs:decimal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of credit transaction amounts in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="DebitCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of debit transactions in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="DebitAmt" type="xs:decimal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of debit transaction amounts in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="SaleCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of sale transactions in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="SaleAmt" type="xs:decimal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of sale transaction amounts in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="ReturnCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of return transactions in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="ReturnAmt" type="xs:decimal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of return transaction amounts in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="TotalCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Total number of transactions in the batch</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="TotalAmt" type="amtTypeGlobal">
        <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="TotalGratuityAmtInfo" type="amtTypeGlobal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of gratuity amounts in the batch. Gratuity amounts, if any, are already included in the other amounts.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="TotalSurchargeAmtInfo" type="amtTypeGlobal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of surcharge amounts in the batch.  Surcharge amounts, if any, are already included in the other amounts.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="TotalHCPCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Total number of Home Currency Pay transactions 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="HostTotalCnt" 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="HostTotalAmt" 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:element name="HostCreditSaleCnt" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of credit sale transactions in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostCreditSaleAmt" type="xs:decimal" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of credit sale transaction amounts in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostCreditReturnCnt" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of credit return transactions in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostCreditReturnAmt" type="xs:decimal" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of credit return transaction amounts in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostDebitSaleCnt" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of debit sale transactions in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostDebitSaleAmt" type="xs:decimal" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of debit sale transaction amounts in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostDebitReturnCnt" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of debit return transactions in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HostDebitReturnAmt" type="xs:decimal" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of debit return transaction amounts in the host batch.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="VisaDirectCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of Visa Direct transactions processed</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="VisaDirectAmt" type="xs:decimal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of Visa Direct transaction processed</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="MCSendCnt" type="xs:int">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Number of Mastercard Send transactions processed</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="MCSendAmt" type="xs:decimal">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Sum of Mastercard Send transaction processed</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:all>
  </xs:complexType>
</xs:element>
See Also
PosReportBatchSummaryRspType Complex Type | PosGateway Schema

 

 

© 2024 Heartland Payment Systems, Inc.