PosReportOpenAuthsRspType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

PosReportOpenAuthsRspType

Sequence

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

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

TxnCnt xs:int

Number of transactions in the batch

TxnAmt xs:decimal

Sum of transaction amounts in the batch

Details 0..∞

Report details, sorted by DeviceId, TxnUtcDT

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

GatewayTxnId txnIdType Simple Type

TxnStatus xs:string

The current transaction status at the time of the search.

These can vary, but some of the key status values include:

Active - 'A'
Closed - 'C'
Voided - 'V'
Inactive - 'I'
Reversed - 'R'

TxnUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

SiteTrace xs:string

DebitCreditInd xs:string

Indicates if the transaction was a 'D' (debit) or 'C' (credit)

SaleReturnInd xs:string

Indicates if the transaction was a 'S' (sale) or 'R' (return)

CardSwiped xs:string

Indicates whether or not the payment method from the original transaction was swiped; 'Y' indicates that it was and 'N' that it was not.

CardType xs:string

MaskedCardNbr xs:string

This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.

CardHolderLastName xs:string

CardHolderFirstName xs:string

CardHolderAddr xs:string

CardHolderCity xs:string

CardHolderState xs:string

CardHolderZip xs:string

CardHolderPhone xs:string

CardHolderEmail xs:string

Amt amtTypeGlobal Simple Type

The original requested amount

AuthAmt amtTypeGlobal Simple Type

The actual authorized amount

Note: This can be different from the original requested amount for partial authorizations.

SettlementAmt amtTypeGlobal Simple Type

The amount the transaction would settle for if it were closed as part of a batch

Note: This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.

Note: This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.

GratuityAmtInfo amtTypeGlobal Simple Type

CashbackAmtInfo amtTypeGlobal Simple Type

RspCode xs:string

Issuer response code

RspText xs:string

Issuer response text

AuthCode xs:string

AVSRsltCode xs:string

CVVRsltCode xs:string

DirectMktInvoiceNbr xs:string

DirectMktShipMonth xs:int

DirectMktShipDay xs:int

CPCCardHolderPONbr xs:string

CPCTaxType xs:string

CPCTaxAmt amtTypeGlobal Simple Type

TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

TxnDT xs:dateTime

Transaction response date time in the time zone conversion requested

ClerkID optional xs:string

CredentialData optional CredentialDataType Complex Type

Credential details tied to a user session

Note: This is for internal use only.

All

DisplayName optional descriptionType Simple Type

User display name

ImpersonatedDisplayName optional xs:string

Impersonated user display name

EMVChipCondition optional xs:string

HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that it did and 'N' that it did not.

Used By

ReportOpenAuths Element

Source

<xs:complexType name="PosReportOpenAuthsRspType" 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="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="TxnCnt" 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="TxnAmt" 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: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, TxnUtcDT</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="GatewayTxnId" type="txnIdType" />
          <xs:element name="TxnStatus" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The current transaction status at the time of the search.</p>
                <p xmlns="http://Hps.Exchange.PosGateway">
                    These can vary, but some of the key status values include:
                    <ul><li>Active - 'A'</li><li>Closed - 'C'</li><li>Voided - 'V'</li><li>Inactive - 'I'</li><li>Reversed - 'R'</li></ul></p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TxnUtcDT" type="xs:dateTime">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Transaction response date time in UTC (Coordinated Universal Time)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="SiteTrace" type="xs:string" />
          <xs:element name="DebitCreditInd" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates if the transaction was a 'D' (debit) or 'C' (credit)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="SaleReturnInd" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates if the transaction was a 'S' (sale) or 'R' (return)</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CardSwiped" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether or not the payment method from the original transaction was swiped; 'Y' indicates that it was and 'N' that it was not.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CardType" type="xs:string" />
          <xs:element name="MaskedCardNbr" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">This is the original transaction's card number, if any. It will contain the first six and last four digits with '*' filling in the middle. This value is safe for receipts and displays.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CardHolderLastName" type="xs:string" />
          <xs:element name="CardHolderFirstName" type="xs:string" />
          <xs:element name="CardHolderAddr" type="xs:string" />
          <xs:element name="CardHolderCity" type="xs:string" />
          <xs:element name="CardHolderState" type="xs:string" />
          <xs:element name="CardHolderZip" type="xs:string" />
          <xs:element name="CardHolderPhone" type="xs:string" />
          <xs:element name="CardHolderEmail" type="xs:string" />
          <xs:element name="Amt" type="amtTypeGlobal">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The original requested amount</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AuthAmt" type="amtTypeGlobal">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The actual authorized amount</p>
                <p xmlns="http://Hps.Exchange.PosGateway" />
                <p xmlns="http://Hps.Exchange.PosGateway">
                  <strong>Note:</strong> This can be different from the original requested amount for partial authorizations.
                  </p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="SettlementAmt" type="amtTypeGlobal">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The amount the transaction would settle for if it were closed as part of a batch</p>
                <p xmlns="http://Hps.Exchange.PosGateway" />
                <p xmlns="http://Hps.Exchange.PosGateway">
                  <strong>Note:</strong> This does not mean that it has or will close for this amount. The client controls this by adding it to the batch and closing the batch.
                  </p>
                <p xmlns="http://Hps.Exchange.PosGateway" />
                <p xmlns="http://Hps.Exchange.PosGateway">
                  <strong>Note:</strong> This can be different from the original requested amount or the authorized amount for many reasons including: transaction edits (tip), reversals, additional authorizations, etc.
                  </p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="GratuityAmtInfo" type="amtTypeGlobal" />
          <xs:element name="CashbackAmtInfo" type="amtTypeGlobal" />
          <xs:element name="RspCode" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Issuer response code</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="RspText" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Issuer response text</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AuthCode" type="xs:string" />
          <xs:element name="AVSRsltCode" type="xs:string" />
          <xs:element name="CVVRsltCode" type="xs:string" />
          <xs:element name="DirectMktInvoiceNbr" type="xs:string" />
          <xs:element name="DirectMktShipMonth" type="xs:int" />
          <xs:element name="DirectMktShipDay" type="xs:int" />
          <xs:element name="CPCCardHolderPONbr" type="xs:string" />
          <xs:element name="CPCTaxType" type="xs:string" />
          <xs:element name="CPCTaxAmt" type="amtTypeGlobal" />
          <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="TxnDT" type="xs:dateTime">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Transaction response date time in the time zone conversion requested</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="ClerkID" type="xs:string" minOccurs="0" />
          <xs:element name="CredentialData" type="CredentialDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Credential details tied to a user session</p>
                <p xmlns="http://Hps.Exchange.PosGateway" />
                <p xmlns="http://Hps.Exchange.PosGateway">
                  <strong>Note:</strong> This is for internal use only.
                  </p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="EMVChipCondition" type="xs:string" minOccurs="0" />
          <xs:element name="HasEMVTag" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that it did and 'N' that it did not.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:all>
      </xs:complexType>
    </xs:element>
  </xs:sequence>
</xs:complexType>