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

Report details sorted by 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.

Namespace http://Hps.Exchange.PosGateway
Diagram
CurrencyCodeAlpha Element CurrencyConversion Element x_global_transaction_id Element HostItemNbr Element HostBatchNbr Element AltPaymentData Element CustomerLastname Element CustomerFirstname Element Company Element HasEMVTag Element EMVChipCondition Element SurchargeAmtInfo Element RecurringData Element PaymentMethodKey Element AttachmentInfo Element ShippingAmtInfo Element ConvenienceAmtInfo Element CredentialData Element AdditionalTxnFields Element ServiceName Element ClerkID Element LodgingData Element Amt Element TxnDT Element TzConversion Element CPCTaxAmt Element CPCTaxType Element CPCCardHolderPONbr Element DirectMktShipDay Element DirectMktShipMonth Element DirectMktInvoiceNbr Element CVVRsltCode Element AVSRsltCode Element AuthCode Element RspText Element RspCode Element SettlementAmt Element AuthAmt Element CashbackAmtInfo Element GratuityAmtInfo Element CardHolderEmail Element CardHolderPhone Element CardHolderZip Element CardHolderState Element CardHolderCity Element CardHolderAddr Element CardHolderFirstName Element CardHolderLastName Element MaskedCardNbr Element CardType Element CardSwiped Element SaleReturnInd Element DebitCreditInd Element SiteTrace Element TxnStatus Element TxnUtcDT Element GatewayTxnId Element Sequence Details Element
Overview
Details 0..∞

Report details sorted by 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.

Sequence
GatewayTxnId txnIdType Simple Type
TxnUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

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'

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
GratuityAmtInfo amtTypeGlobal Simple Type
CashbackAmtInfo amtTypeGlobal Simple Type
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 this 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.

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

Amt amtTypeGlobal Simple Type

The original requested amount

LodgingData optional LodgingDataType Complex Type
All
PrestigiousPropertyLimit optional prestigiousPropertyType Simple Type

This field is used by merchants participating in the Prestigious Lodging Program; see the associated Type enumerations for specific values supported.

Note: This field has been deprecated and should no longer be used.

NoShow optional booleanType Simple Type

Indicates that this charge is due to a "no show" on a reservation

AdvancedDepositType optional advancedDepositTypeType Simple Type

For AMEX only. Indicates the advanced deposit type; see the associated Type enumerations for specific values supported.

LodgingDataEdit optional LodgingDataEditType Complex Type

Lodging extra charge indicators; common group of elements that provide additional details specific to lodging transactions that may be required in certain situations as determined by the brands

All
FolioNumber optional folioNumberType Simple Type

Lodging system generated value used to group and manage charges during a stay

Duration optional xs:int

Duration of stay in days

The stay Duration range is from 1 to 99.

CheckInDate optional xs:date

Date of check-in

CheckOutDate optional xs:date

Date of check-out

Rate optional amtTypeGlobal Simple Type

Daily room rate

Note: This field is required by AMEX.

RoomTax optional amtTypeGlobal Simple Type

Total Room Tax Charges. For Feature Use

ExtraCharges optional ExtraChargesDataType Complex Type

Indicates the types of extra charges included in the extra charge amount information and the total transaction amount

ExtraChargeAmtInfo optional amtTypeGlobal Simple Type

Total extra charge amount information; this defines the portion of the total amount provided as part of this request that was specifically for lodging extra charges. This is informational only and will not alter the amount processed as part of the transaction.

ExtraChargeDetailAmtInfo optional ExtraChargeDetailAmtInfoDataType Complex Type

Defines the individual amounts of extra charges included in the extra charge amount information and the total transaction amount.

ExtraChargesDetailAmountInfo can be used by Asia Pacific merchants only.

PreferredCustomer optional booleanType Simple Type

For MasterCard only. Indicates whether or not the customer has a preferred status.

ClerkID optional Restriction of xs:string
ServiceName optional xs:string

This is the original request type (i.e. CreditSale)

AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type
All
Description optional descriptionType Simple Type

Free-form description field. This must not contain sensitive information.

InvoiceNbr optional Restriction of xs:string

Used to log the invoice number on transactions that are not eCommerce.

CustomerID optional customerIDType Simple Type

Used to log Merchant specific customer identification.

Note: For GETI check transactions, this is sent in the CUSTOM3 field.

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

ConvenienceAmtInfo optional amtTypeGlobal Simple Type
ShippingAmtInfo optional amtTypeGlobal Simple Type
AttachmentInfo 0..4 AttachmentInfoType Complex Type

Information regarding attachments that are available for this transaction.

All
AIType xs:string

Identifies the attachment type; see Simple Types, attachmentTypeType enumerations for specific values supported.

AIFormat optional xs:string

Identifies the format of the attachment data; see Simple Types, attachmentFormatType enumerations for specific values supported

PaymentMethodKey optional guidType Simple Type
RecurringData optional RecurringDataType Complex Type
All
ScheduleID optional scheduleIDType Simple Type

The PayPlan ScheduleIdentifier

OneTime optional booleanType Simple Type

Indicates a one-time payment (Y) or a recurring payment (N); if not provided N is assumed.

RecurringDataCode optional xs:string

MasterCard value that may be returned on recurring transactions.

Note: This is returned in the response and should never be used in the request.

SurchargeAmtInfo optional amtTypeGlobal Simple Type
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

Company optional xs:string

The company associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerFirstname optional xs:string

The customer first name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

CustomerLastname optional xs:string

The customer last name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.

AltPaymentData optional AltPaymentDataType Complex Type

A collection of AltPayment transaction related fields

Sequence
TaxAmtInfo optional amtTypeGlobal Simple Type
Tax Amount
Status optional xs:string
Status
StatusMsg optional xs:string
Status Message
BuyerEmailAddress optional xs:string

The Buyer Email Address associated with the AltPayment at the time the transaction was processed.

StatusDT optional xs:dateTime

Date and time the status was recorded.

ProcessorRspInfo 0..∞ ProcessorRspInfoType Complex Type

Additional data that may be provided by specific processors

Sequence
Code optional xs:string

Code from processor response

Message optional xs:string

Message from processor response

Type optional xs:string

Type of processor response

HostBatchNbr optional xs:int

Host batch number.

HostItemNbr optional xs:int

Host batch item number.

x_global_transaction_id optional x_global_transaction_idType Simple Type

Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be retrieved.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

Integration must be through GP-API

All
CurrConvOptOutFlag booleanType Simple Type

This setting indicates if the Customer has decided Opt Out of currency conversion and have the amount remain in the Merchants currency. If the customer does not opt out, the amount will be converted to currency associated with the card.

RateLookupTxnId optional guidType Simple Type

The Retrieval Reference Number (RRN) of the RateLookup or Incremental Authorization that provided the rate used for the calculations in this transaction, if it is different from the original Authorization.

CardHolderCurrCode optional currCodeType Simple Type

Indicates the currency associated with the cardholder card.

CardHolderAmt optional amtTypeGlobal Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional Restriction of xs:decimal

The mark up percentage applied to the transaction, resulting in the commission fee.

CurrencyCodeAlpha xs:string

Indicates the currency text associated with the CardHolderCurrCode.

Source
<xs:element name="Details" minOccurs="0" maxOccurs="unbounded" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">Report details sorted by 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:sequence>
      <xs:element name="GatewayTxnId" type="txnIdType" />
      <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="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="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="GratuityAmtInfo" type="amtTypeGlobal" />
      <xs:element name="CashbackAmtInfo" type="amtTypeGlobal" />
      <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 this 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="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="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="LodgingData" type="LodgingDataType" minOccurs="0" />
      <xs:element name="ClerkID" minOccurs="0">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:maxLength value="50" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element name="ServiceName" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">This is the original request type (i.e. CreditSale)</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="AdditionalTxnFields" type="AdditionalTxnFieldsType" 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="ConvenienceAmtInfo" type="amtTypeGlobal" minOccurs="0" />
      <xs:element name="ShippingAmtInfo" type="amtTypeGlobal" minOccurs="0" />
      <xs:element name="AttachmentInfo" type="AttachmentInfoType" minOccurs="0" maxOccurs="4">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Information regarding attachments that are available for this transaction.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="PaymentMethodKey" type="guidType" minOccurs="0" />
      <xs:element name="RecurringData" type="RecurringDataType" minOccurs="0" />
      <xs:element name="SurchargeAmtInfo" type="amtTypeGlobal" minOccurs="0" />
      <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:element name="Company" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">The company associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="CustomerFirstname" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">The customer first name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="CustomerLastname" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">The customer last name associated with the recurring payment at the time the transaction was processed. This only appears for recurring payment transactions.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="AltPaymentData" type="AltPaymentDataType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">A collection of AltPayment transaction related fields</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="HostItemNbr" type="xs:int" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Host batch item number.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="x_global_transaction_id" type="x_global_transaction_idType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be retrieved.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="CurrencyConversion" type="CurrConversionDataType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Data block for Currency Conversion.</p>
            <p xmlns="http://Hps.Exchange.PosGateway">Integration must be through GP-API</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="CurrencyCodeAlpha" type="xs:string">
        <xs:annotation>
          <xs:documentation>
            <p xmlns="http://Hps.Exchange.PosGateway">Indicates the currency text associated with the CardHolderCurrCode.</p>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
PosReportBatchDetailRspType Complex Type | PosGateway Schema

 

 

© 2024 Heartland Payment Systems, Inc.