Open the Portico Developer Guide site
PosGateway Schema
PosReportTxnDetailRspType Complex Type
PosGateway Schema : PosReportTxnDetailRspType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
SCAExemptionData Element EUSingleTap Element IPData Element IPSelectedTerms Element CurrencyCodeAlpha Element CurrencyConversion Element SDKNameVersion Element SAFData Element RewardCashData Element CorporateData Element CrossMidTidInd Element AuthenticatedDeviceId Element AuthenticatedSiteId Element MerchAddr3 Element x_global_transaction_id Element Data Element UniqueDeviceId Element TzConversion Element MerchPhone Element MerchZip Element MerchState Element MerchCity Element MerchAddr2 Element MerchAddr1 Element TermOrdinal Element MerchNbr Element OriginalGatewayTxnId Element SiteTrace Element RspDT Element RspUtcDT Element ReqDT Element ReqUtcDT Element GatewayRspMsg Element GatewayRspCode Element ServiceName Element UserName Element DeviceId Element MerchName Element SiteId Element ClientTxnId Element GatewayTxnId Element All PosReportTxnDetailRspType Complex Type
Overview
All
SiteId xs:int

Site identifier used to process the request.

MerchName xs:string

Merchant name associated with this site id

DeviceId xs:int

Device identifier used to process the request.

UserName xs:string
ServiceName xs:string

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

GatewayRspCode xs:int

Gateway response code (issuer is separate)

GatewayRspMsg xs:string

Gateway response message

ReqUtcDT xs:dateTime

Transaction request date time in UTC (Coordinated Universal Time)

ReqDT xs:dateTime

Transaction request date time in the time zone conversion requested

RspUtcDT xs:dateTime

Transaction response date time in UTC (Coordinated Universal Time)

RspDT xs:dateTime

Transaction response date time in the time zone conversion requested

SiteTrace xs:string
OriginalGatewayTxnId txnIdType Simple Type

If the transaction performed an action on a previous transaction, this field records the transaction ID that was acted upon.

MerchNbr xs:string

The merchant number (MID) associated with this site id

TermOrdinal xs:int

Terminal ordinal number associated with this device id

MerchAddr1 xs:string

Merchant address 1 associated with this site id

MerchAddr2 xs:string

Merchant address 2 associated with this site id

MerchCity xs:string

Merchant city associated with this site id

MerchState xs:string

Merchant state associated with this site id

MerchZip xs:string

Merchant zip associated with this site id

MerchPhone xs:string

Merchant phone number associated with this site id

TzConversion tzoneConversionType Simple Type

Time zone conversion applied to report results

UniqueDeviceId optional xs:string
Data

Transaction details

Sequence
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'

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.

CardPresent xs:string
ReaderPresent xs:string
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

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)

CVVReq xs:string
CVVRsltCode 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.

CardHolderAddr xs:string
CardHolderCity xs:string
CardHolderState xs:string
CardHolderZip xs:string
CardHolderPhone xs:string
CardHolderEmail xs:string
AVSRsltCode xs:string
CPCReq xs:string
CPCInd xs:string
RspCode xs:string

Issuer response code

RspText xs:string

Issuer response text

AuthCode xs:string
ReqACI xs:string

Requested authorization characteristics indicator

RspACI xs:string

Response authorization characteristics indicator

MktSpecDataId xs:string

Market specific data identifier

TxnCode xs:string

Transaction code

AcctDataSrc xs:string

Account data source code. This is a derived value that represents the source of the account data received. For example, proximity vs. swiped vs. manual, et al.

AuthSrcCode xs:string

Authorization source code

IssTxnId xs:string

Issuer transaction identifier

IssValidationCode xs:string

Issuer validation code

CardHolderIdCode xs:string

Card holder identification code

NetworkIdCode xs:string

Network identification code

RefNbr xs:string

Retrieval reference number

TxnSeqNbr xs:int

Transaction sequence number incremented with each authorization requested by a device

AmountIndicator xs:string

Valid values include:

  • 'E' indicates that the transaction amount is an estimated amount
  • 'F' indicates the transaction amount is the final amount to be charged to the cardholder

CPCTaxType xs:string
SalesTaxDetails optional SalesTaxDetailsType Complex Type

Allows sending the Canadian sales tax details for corporate card processing.

All
GSTAmt optional amtTypeGlobal Simple Type

Goods and Services Tax.

HSTAmt optional amtTypeGlobal Simple Type

Harmonized Sales Tax.

PSTAmt optional amtTypeGlobal Simple Type

Provincial Sales Tax.

QSTAmt optional amtTypeGlobal Simple Type

Quebec Sales Tax.

BuyerRecipientName optional Restriction of xs:string

Required on transactions with an amount over 150.

PSTTaxRegistration optional pstTaxRegistrationType Simple Type

Provincial Sales Tax Registration number.

MerchantVATRegistration Restriction of xs:string

Merchant Value Added Tax Registration number.

CustomerVATRegistration Restriction of xs:string

Customer Value Added Tax Registration number.

CustomerRefId Restriction of xs:string

Canadian customer reference Id.

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.

All
RealTimeSubstantiation booleanType Simple Type

Indicates whether a merchant supports real-time Substantiation

FirstAdditionalAmtInfo AdditionalAmtType Complex Type

First Additional Amount information

SecondAdditionalAmtInfo optional AdditionalAmtType Complex Type

Second Additional Amount information

ThirdAdditionalAmtInfo optional AdditionalAmtType Complex Type

Third Additional Amount information

FourthAdditionalAmtInfo optional AdditionalAmtType Complex Type

Fourth Additional Amount information

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.

All
GatewayTxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction.

AttachmentType xs:string

Identifies the attachment types to be returned; see the attachmentTypeType enumerations for specific values supported.

AttachmentData xs:string

Base64 encoded attachment data

AttachmentFormat xs:string

Identifies the format of the attachment data; see the attachmentFormatType enumerations for specific values supported.

Height optional xs:int

For image formats, this is the height calculated internally based on the provided data.

Width optional xs:int

For image formats, this is the width calculated internally based on the provided data.

AttachmentName optional Restriction of xs:string

A merchant-assigned name for the associated attachment

AttachmentDataId xs:int

Gateway-generated attachment identifier

AVSRsltText optional xs:string
CVVRsltText optional xs:string
TokenizationMsg optional xs:string

Tokenization action taken

CryptoTypeIn optional xs:string

Encryption type in request

CryptoTypeOut optional xs:string

Encryption type used internally

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

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 LodgingDataEditForReportType 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

PreferredCustomer optional booleanType Simple Type

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

TxnDescriptor optional xs:string
CheckDataInfo optional CheckDataInfoType Complex Type

A collection of check transaction related fields

Sequence
AccountInfo optional AccountInfoType Complex Type

Account information

ConsumerInfo optional ConsumerInfoType Complex Type

Consumer information

SECCode optional xs:string
CheckRspInfo 0..∞ CheckRspInfoType Complex Type

Additional data that may be provided by specific check processors

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

GiftData optional GiftDataType Complex Type

A collection of stored value transaction related fields

All
GiftMaskedAlias optional Restriction of xs:string

The alias used masked with '*' to only show part of the value

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.

CashData optional CashDataType Complex Type

A collection of cash transaction related fields

ReturnAmtInfo optional amtTypeGlobal Simple Type

This is the total amount of returns that have been done against this specific transaction

ReversalAmtInfo optional amtTypeGlobal Simple Type

This is the total amount of reversals that have been done against this specific transaction

IncrementalAuthAmtInfo optional amtTypeGlobal Simple Type

This is the total amount of incremental authorizations that have been done against this specific transaction

AllowDup optional Restriction of xs:string
SystemAuditTraceNumber optional Restriction of xs:string

System audit trace number

LodgingCheckInDate optional xs:dateTime
LodgingCheckOutDate optional xs:dateTime
ProcessorRefNum optional Restriction of xs:string

Reference number returned by processor

ReversalIndicator optional Restriction of xs:string

Indicates that this transaction was reversed

TokenRequested optional Restriction of xs:string

Indicates that a request for a token was made on this transaction

TokenGenerated optional Restriction of xs:string

Indicates that a Token was generated as a result of this transaction

EMVChipCondition optional xs:string
EMVTagData optional xs:string

EMV tag data in TLV format.

Note: This field has been obsoleted.See the TagData field for the alternative.

EMVIssuerResp optional xs:string

EMV tag data returned by the issuer in TLV format

TypeOfPaymentData optional xs:string

Type of SecureECommerce Payment Data.

PaymentData optional xs:string

SecureECommerce Payment Data.

ECommerceIndicator optional xs:string

Electronic Commerce Indicator when using SecureECommerce.

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code returned by the Issuer when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token returned by the Issuer when using SecureECommerce.

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.

DebtRepaymentIndicator optional debtRepaymentType Simple Type

Allows for flagging this transaction as being against a debt obligation. Only use this field with Heartland's explicit direction. This flag is used to identify transactions that might qualify for VISA's Debt Repayment Program special interchange rates.

AltPaymentData optional AltPaymentDataType Complex Type

A collection of AltPayment transaction related fields

Sequence
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

MultiFulfillmentData optional MultiFulfillmentDataType Complex Type

A collection of transaction of multi-fulfillment related fields

All
CaptureAmtInfo optional amtTypeGlobal Simple Type
Captured Amount
FullyCapturedInd optional booleanType Simple Type

Indicates whether or not the AltpaymentCapture has been fully captured.

PaymentDataSource optional xs:string

Source of SecureECommerce Payment Data.

TagData optional TagDataType Complex Type

EMV or Non-EMV tag data in TLV format

All
TagValues optional Extension of xs:string

This field holds the tag data values.

XID optional xs:string

SecureECommerce XID.

CardOnFileData optional CardOnFileDataType Complex Type

The Card on File data received in the request.

All
CardBrandTxnId optional restrictedStringType Simple Type

Network Transaction Identifier

CardOnFile optional CardOnFileType Simple Type

Card On File Indicator

Valid values include:

  • 'C' - Cardholder initiated transaction
  • 'M' - Merchant initiated transaction

CategoryInd optional CategoryIndType Simple Type

Mastercard CIT/MIT indicator subcategory

Valid values include:

  • 01 - Unscheduled Credential-on-file
  • 02 - Standing Order (variable amount and fixed frequency)
  • 03 - Subscription (fixed amount and frequency)
  • 06 - Related/Delayed Charge
  • 07 - No Show Charge
  • 08 - Resubmission

Note: Future use for GSAP-AP merchants

CardBrandTxnId optional xs:string

The CardBrandTxnId for this transaction.

All
PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator. This identifier is for use only by the payment facilitator, and should not be used as a reference in future client requests to the Portico Gateway.

PaymentFacilitatorTxnNbr optional xs:string

Unique account identifier assigned by the payment facilitator for the sub-merchant. This is used as the sub-merchant account reference if contacting the payment facilitator for support.

All
Version optional versionType Simple Type

Indicates 3DS version used for authentication. Default version is 1.

AuthenticationValue optional Extension of authenticationValueType Simple Type

This value is the reference generated by the issuer to recognize that the authentication has taken place. Supported formats are CAVV, AEVV, UCAF. Must be encoded using base16 (Hex encoding) or base64 encoding.

ECI eciType Simple Type

Electronic Commerce Indicator shows the value of the result of the authentication.

Note: This value represents UCI for MasterCard.

DirectoryServerTxnId optional directoryServerTxnIdType Simple Type

The unique transaction identifier assigned by the Directory Server to identify a single transaction.

Note: Required for MasterCard Identity Check (3DS Version 2) transactions in Authorization.

All
PaymentSource PaymentDataSourceType Simple Type

Payment Source is the API or source of the cryptogram.

Cryptogram optional Extension of cryptogramType Simple Type

Cryptogram received from wallet payment. Supported formats are DSRP, TokenBlocks and TAVV cryptograms. Must be encoded using base16 (Hex encoding) or base64 encoding.

ECI optional eciType Simple Type

Electronic Commerce Indicator associated with the Cryptogram. This is an optional field.

DigitalPaymentToken optional xs:string

Payment payload used to send encrypted apple or google pay data.

TokenRequestorId optional tokenRequestorIdType Simple Type

FOR FUTURE USE

Value associated with a specific network token that uniquely identifies the pairing of a token requestor with a token domain.

NetworkToken optional cryptogramTypeType Simple Type

FOR FUTURE USE

For use with NetworkToken only. If type is not provided, and a cryptogram is sent, Portico will use the default cryptogram type for the card brand.

ProcessedTxnMcc optional mccType Simple Type

The merchant category code (MCC)  used in the authorization request; if not provided the default MCC configured for the Device is assumed.

TransactionType xs:string

This is the OCT transaction type

RecipientCountry xs:string

This is the recipient country name

ServiceLocation optional ServiceLocationType Complex Type

The Service Location data received in the request.

All
ServiceCity optional serviceCityType Simple Type

City where the cardholder received the services, if different from the merchant’s city

ServiceCountrySubdivision optional serviceCountrySubdivisionType Simple Type

Country subdivision where the cardholder received the services, if different from the merchant’s country subdivision

ServiceCountryCode optional serviceCountryCodeType Simple Type

Postal code where the cardholder received the services, if different from the merchant’s postal code.

ServiceZipPostalCode optional serviceZipPostalCodeType Simple Type

Details of the location where services are provided, if different from the merchant’s location. Should be provided for Mastercard transactions where applicable.

MerchAddr3 optional xs:string

Merchant address 3 associated with this site id

AuthenticatedSiteId optional siteIdType Simple Type

Authenticated Site identifier received in the request header.

AuthenticatedDeviceId optional deviceIdType Simple Type

Authenticated Device identifier received in the request header.

CrossMidTidInd optional xs:string

Indicates whether the transaction was processed as a Cross MID or Cross TID transaction.

CorporateData optional CorporateDataType Complex Type

Corporate/Purchasing Card Level III data

Sequence
Choice
Visa VisaType Complex Type

Visa Corporate/Purchasing Card Level III data.

All
SummaryCommodityCode optional Restriction of xs:string

Contains the 4-character national standard coding structure for the description of goods.May contain be null or all spaces.

DiscountAmt optional Restriction of xs:decimal

Contains the total discount amount applied to the transaction. This field may be null or contain zeroes if no discount was given.

If amount value is positive, then value is treated as discount for the invoice.

If amount value is negative, then value is treated as refund discount for the invoice.

FreightAmt optional Restriction of xs:decimal

Contains the total Freight/Shipping Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

DutyAmt optional Restriction of xs:decimal

Contains the Duty Amount. This field may be null or contain zeroes if no freight/shipping amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

NOTE: Duty may also be called Import Tax, Excise, or Customs Tax.

DestinationPostalZipCode optional Restriction of xs:string

Postal code of destination location. May contain spaces.

ShipFromPostalZipCode optional Restriction of xs:string

Postal code of the location being shipped from. May contain spaces.

DestinationCountryCode optional Restriction of xs:string

The 3-digit ISO Numeric Country Code of destination location (eg, 840). May contain spaces

InvoiceRefNbr optional Restriction of xs:string

Value Added Tax invoice reference number. May contain spaces.

OrderDate optional xs:dateTime

Date the order was taken. May be null or contain zeros.

VATTaxAmtFreight optional Restriction of xs:decimal

Contains any Value Added Tax Amount or Other Sales Tax Amount. This field may be null or contain zeroes if no freight/shipping tax amount was applied.

If amount value is positive, then value is treated as positive for the invoice.

If amount value is negative, then value is treated as negative for the invoice.

VATTaxRateFreight optional Restriction of xs:decimal

The Tax Rate of the Value Added Tax or Other Sales Tax.

DiscountTreatment optional Restriction of xs:int

Indicates how the merchant is managing discount.

Valid values:

0 - no invoice level discount provided

1 - tax was calculated on the post-discount invoice total.

2 - tax was calculated on the pre-discount invoice total.

TaxTreatment optional Restriction of xs:int

Indicates how the merchant is handling taxes

Valid values:

0 - NLL (net prices with tax calculated a line item level)

1 - NIL (net prices with tax calculated at invoice level)

2 - GLL (gross prices given with tax information provided at the line item level)

3 - GIL (gross prices given with tax information provided at invoice level)

4 - NON (no tax applies on the invoice for the transaction)

LineItems optional
MC MCType Complex Type

MC Corporate/Purchasing Card Level III data.

All
RewardCashData optional RewardCashDataType Complex Type

RewardCashData details.

All
Quantity1 optional xs:int
Quantity2 optional xs:int
Quantity3 optional xs:int
RewardCashRedeemed xs:decimal

Points redeemed

FileReferenceNbr xs:string

Reference number returned by the processor or issuer

SAFData optional SAFDataType Complex Type

SAF details

All
SAFIndicator booleanType Simple Type

Indicates that transaction was initiated in "store and forward" (SAF) mode (Y)

SAFOrigDT optional xs:dateTime

Date and time when the transaction was originally initiated.

SDKNameVersion optional

Name and Version of the SDK used for integration, where applicable.

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.

IPSelectedTerms optional IPSelectedTermsReqType Complex Type

This service is only available for merchants on the AP host, or merchants in Mexico on the GSAP host.

All
Program optional programType Simple Type

Available to merchants in Asia Pacific, Mexico, and Canada.

For merchants in Canada, use VIS.

Valid values include:

  • HSBCIPP
  • mIPP
  • SIP
  • VIS

SIPOptions optional sipOptionsType Simple Type

Available to merchants in Asia Pacific. Required when the Program is SIP

Valid values include:

  • 01 - SIPZERO
  • 02 - SIPREGULAR
  • 03 - SIPMADNESS

InstallmentPlan optional installmentPlanType Simple Type

Required for merchants in Mexico

Valid values include:

  • 00 - No promotion
  • 03 - Without interest to the cardholder
  • 05 - With interest to the cardholder
  • 07 - Buy today, pay later

GracePeriod optional gracePeriodType Simple Type

The grace period before the first payment. 00 indicates no grace period

Required for merchants in Mexico

NbrInstallments optional nbrInstallmentsType Simple Type

The total number of installments

This field is available to merchants in Asia Pacific and merchants in Mexico

PlanId optional planIdReqType Simple Type

The PlanId of the customer's selected VIS installment plan

Required when the Program is VIS

TermsConditionVersion optional termsConditionVersionReqType Simple Type

The Terms and Conditions version the customer's selected VIS installment plan

Required when the Program is VIS

TermsConditionLanguage optional termsConditionLanguageReqType Simple Type

The Language Code the customer's selected VIS installment plan

Required when the Program is VIS

IPData optional IPDataBlockType Complex Type

Information regarding Installment Plans associated with the transaction. Currently only returned for Visa Installment Service (VIS).

All
PlanId optional planIdReqType Simple Type

The reference ID of the VIS Installment Plan chosen by the customer.

EUSingleTap optional booleanType Simple Type

This field provides a way for a European merchant to indicate whether a transaction is a Single Tap contactless transaction, or whether the request contains an intentionally duplicated (replayed) ATC value. Applies to MC transactions only. Valid values: Y - SingleTap N - ReplayedATC

SCAExemptionData optional SCAExemptionDataType Complex Type

This fields provides a way for a European merchant to indicate that the transaction can take advantage of one of the exemptions to SCA. Applies to visa transactions only.

All
SCAExemptionType SCAExemptionTypeType Simple Type

Eligible exemption to Strong Customer authentication (SCA) for the transaction.

Valid values include:

  • 'TrustedMerchant' Trusted merchant exemption claimed/requested.
  • 'LowValue' Transaction exemption from SCA as the merchant has determined it to be a low value payment.
  • 'SecureCorporatePayment' Transaction exemption from SCA as the merchant has determined it as a SCP.
  • 'TxnRiskAnalysis' TRA exemption claimed/requested.
  • 'DelegatedAuth' Issuer has delegated SCA.
  • 'AuthenticationOutage' Authentication outage
  • 'MerchantInitiated' Merchant initiated
  • 'RecurringPayment' Recurring payment

Note: Visa Merchant ID is required when the SCA Exemption Type is Trusted Merchant or Delegated Authentication.

SCAVisaMerchantId optional Restriction of xs:string

Note: Visa Merchant ID for Trusted Merchant and Delegated Authentication exemptions, required when the SCA Exemption Type is Trusted Merchant or Delegated Authentication

Used By
ReportTxnDetail Element
Source
<xs:complexType name="PosReportTxnDetailRspType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="GatewayTxnId" type="txnIdType" />
    <xs:element name="ClientTxnId" type="clientIdType" />
    <xs:element name="SiteId" type="xs:int">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Site identifier used to process the request.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <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:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Device identifier used to process the request.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="UserName" type="xs:string" />
    <xs:element name="ServiceName" type="xs:string">
      <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="GatewayRspCode" type="xs:int">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Gateway response code (issuer is separate)</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="GatewayRspMsg" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Gateway response message</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ReqUtcDT" type="xs:dateTime">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Transaction request date time in UTC (Coordinated Universal Time)</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ReqDT" type="xs:dateTime">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Transaction request date time in the time zone conversion requested</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RspUtcDT" 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="RspDT" 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="SiteTrace" type="xs:string" />
    <xs:element name="OriginalGatewayTxnId" type="txnIdType">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">If the transaction performed an action on a previous transaction, this field records the transaction ID that was acted upon.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchNbr" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The merchant number (MID) associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TermOrdinal" type="xs:int">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Terminal ordinal number associated with this device id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchAddr1" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant address 1 associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchAddr2" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant address 2 associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchCity" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant city associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchState" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant state associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchZip" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant zip associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MerchPhone" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant phone number associated with this site id</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="UniqueDeviceId" type="xs:string" minOccurs="0" />
    <xs:element name="Data">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Transaction details</p>
        </xs:documentation>
      </xs:annotation>
      <xs:complexType>
        <xs:sequence>
          <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="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="CardPresent" type="xs:string" />
          <xs:element name="ReaderPresent" type="xs:string" />
          <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="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="CVVReq" type="xs:string" />
          <xs:element name="CVVRsltCode" 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="GratuityAmtInfo" type="amtTypeGlobal" />
          <xs:element name="CashbackAmtInfo" type="amtTypeGlobal" />
          <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="AVSRsltCode" type="xs:string" />
          <xs:element name="CPCReq" type="xs:string" />
          <xs:element name="CPCInd" type="xs:string" />
          <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="ReqACI" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Requested authorization characteristics indicator</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="RspACI" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Response authorization characteristics indicator</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="MktSpecDataId" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Market specific data identifier</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TxnCode" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Transaction code</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AcctDataSrc" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Account data source code. This is a derived value that represents the source of the account data received. For example, proximity vs. swiped vs. manual, et al.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AuthSrcCode" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Authorization source code</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="IssTxnId" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Issuer transaction identifier</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="IssValidationCode" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Issuer validation code</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CardHolderIdCode" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Card holder identification code</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="NetworkIdCode" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Network identification code</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="RefNbr" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Retrieval reference number</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TxnSeqNbr" type="xs:int">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Transaction sequence number incremented with each authorization requested by a device</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AmountIndicator" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">
                    Valid values include:
                    <ul><li><strong>'E'</strong> indicates that the transaction amount is an estimated amount
                      </li><li><strong>'F'</strong> indicates the transaction amount is the final amount to be charged to the cardholder
                      </li></ul></p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <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="SalesTaxDetails" type="SalesTaxDetailsType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Allows sending the Canadian sales tax details for corporate card processing.</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="AllowPartialAuth" type="booleanType" />
          <xs:element name="AutoSubstantiation" type="AutoSubstantiationReportType" minOccurs="0" />
          <xs:element name="AdditionalTxnFields" type="AdditionalTxnFieldsType" minOccurs="0" />
          <xs:element name="Attachment" type="AttachmentRspDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Attachment data</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AVSRsltText" type="xs:string" minOccurs="0" />
          <xs:element name="CVVRsltText" type="xs:string" minOccurs="0" />
          <xs:element name="Ecommerce" type="eCommerceType" minOccurs="0" />
          <xs:element name="TokenizationMsg" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Tokenization action taken</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CryptoTypeIn" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Encryption type in request</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CryptoTypeOut" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Encryption type used internally</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="LodgingData" type="LodgingDataForReportType" minOccurs="0" />
          <xs:element name="ConvenienceAmtInfo" type="amtTypeGlobal" minOccurs="0" />
          <xs:element name="ShippingAmtInfo" type="amtTypeGlobal" minOccurs="0" />
          <xs:element name="TxnDescriptor" type="xs:string" minOccurs="0" />
          <xs:element name="CheckDataInfo" type="CheckDataInfoType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">A collection of check transaction related fields</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <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="GiftData" type="GiftDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">A collection of stored value transaction related fields</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="CashData" type="CashDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">A collection of cash transaction related fields</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="ReturnAmtInfo" type="amtTypeGlobal" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">This is the total amount of returns that have been done against this specific transaction</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="ReversalAmtInfo" type="amtTypeGlobal" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">This is the total amount of reversals that have been done against this specific transaction</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="IncrementalAuthAmtInfo" type="amtTypeGlobal" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">This is the total amount of incremental authorizations that have been done against this specific transaction</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="AllowDup" minOccurs="0">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:minLength value="1" />
                <xs:maxLength value="1" />
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="SystemAuditTraceNumber" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">System audit trace number</p>
              </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="6" />
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="LodgingCheckInDate" type="xs:dateTime" minOccurs="0" />
          <xs:element name="LodgingCheckOutDate" type="xs:dateTime" minOccurs="0" />
          <xs:element name="ProcessorRefNum" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Reference number returned by processor</p>
              </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="50" />
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="ReversalIndicator" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates that this transaction was reversed</p>
              </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="1" />
                <xs:minLength value="1" />
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="TokenRequested" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates that a request for a token was made on this transaction</p>
              </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="1" />
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="TokenGenerated" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Indicates that a Token was generated as a result of this transaction</p>
              </xs:documentation>
            </xs:annotation>
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="1" />
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="EMVChipCondition" type="xs:string" minOccurs="0" />
          <xs:element name="EMVTagData" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">EMV tag data in TLV format.</p>
                <p xmlns="http://Hps.Exchange.PosGateway" />
                <p xmlns="http://Hps.Exchange.PosGateway">
                  <strong>Note: This field has been obsoleted.</strong>See the TagData field for the alternative.
                  </p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="EMVIssuerResp" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">EMV tag data returned by the issuer in TLV format</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TypeOfPaymentData" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Type of SecureECommerce Payment Data.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="PaymentData" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">SecureECommerce Payment Data.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="ECommerceIndicator" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Electronic Commerce Indicator when using SecureECommerce.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CAVVResultCode" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The Visa Cardholder Authentication Verfication Value results code returned by the Issuer when using SecureECommerce.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TokenPANLast4" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Last 4 digits of PAN associated with Token returned by the Issuer when using SecureECommerce.</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="DebtRepaymentIndicator" type="debtRepaymentType" minOccurs="0" maxOccurs="1">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Allows for flagging this transaction as being against a debt obligation. Only use this field with Heartland's explicit direction. This flag is used to identify transactions that might qualify for VISA's Debt Repayment Program special interchange rates.</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="MultiFulfillmentData" type="MultiFulfillmentDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">A collection of transaction of multi-fulfillment related fields</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="PaymentDataSource" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">Source of SecureECommerce Payment Data.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TagData" type="TagDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">EMV or Non-EMV tag data in TLV format</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="XID" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">SecureECommerce XID.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CardOnFileData" type="CardOnFileDataType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The Card on File data received in the request.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="CardBrandTxnId" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The CardBrandTxnId for this transaction.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="PaymentFacilitatorData" type="PaymentFacilitatorDataType" minOccurs="0" />
          <xs:element name="Secure3D" type="Secure3DType" minOccurs="0" />
          <xs:element name="WalletData" type="WalletDataType" minOccurs="0" />
          <xs:element name="ProcessedTxnMcc" type="mccType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">The merchant category code (MCC)  used in the authorization request; if not provided the default MCC configured for the Device is assumed.</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="TransactionType" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">This is the OCT transaction type</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="RecipientCountry" type="xs:string">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">This is the recipient country name</p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:element name="ServiceLocation" type="ServiceLocationType" minOccurs="0">
            <xs:annotation>
              <xs:documentation>
                <p xmlns="http://Hps.Exchange.PosGateway">
                    The Service Location data received in the request.
                  </p>
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
    <xs:element name="x_global_transaction_id" type="x_global_transaction_idType" minOccurs="0" />
    <xs:element name="MerchAddr3" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Merchant address 3 associated with this site id</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AuthenticatedSiteId" type="siteIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Authenticated Site identifier received in the request header.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AuthenticatedDeviceId" type="deviceIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Authenticated Device identifier received in the request header.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="CrossMidTidInd" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether the transaction was processed as a Cross MID or Cross TID transaction.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="CorporateData" type="CorporateDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Corporate/Purchasing Card Level III data </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RewardCashData" type="RewardCashDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">RewardCashData details.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SAFData" type="SAFDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">SAF details</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SDKNameVersion" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Name and Version of the SDK used for integration, where applicable.</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:element name="IPSelectedTerms" type="IPSelectedTermsReqType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">This service is only available for merchants on the AP host, or merchants in Mexico on the GSAP host.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="IPData" type="IPDataBlockType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Information regarding Installment Plans associated with the transaction. Currently only returned for Visa Installment Service (VIS).</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="EUSingleTap" type="booleanType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">
              This field provides a way for a European merchant to indicate whether a transaction is a Single Tap contactless transaction,
              or whether the request contains an intentionally duplicated (replayed) ATC value. Applies to MC transactions only.
              Valid values:
              Y - SingleTap
              N - ReplayedATC
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SCAExemptionData" type="SCAExemptionDataType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">This fields provides a way for a European merchant to indicate that the transaction can take advantage of one of the exemptions to SCA. Applies to visa transactions only.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
PosGateway Schema