Open the Portico Developer Guide site
Portico Schema
ReportTxnDetail Element
Portico Schema > PosResponse Element > Ver1.0 Element > Transaction Element : ReportTxnDetail Element
Namespace http://Hps.Exchange.PosGateway
Type
PosReportTxnDetailRspType Complex Type
Diagram
IPSelectedTerms Element CurrencyCodeAlpha Element CurrencyConversion 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 ReportTxnDetail Element
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 xs:decimal

The original requested amount

AuthAmt xs:decimal

The actual authorized amount

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

GratuityAmtInfo xs:decimal
CashbackAmtInfo xs:decimal
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

CPCTaxType xs:string
CPCTaxAmt xs:decimal
SettlementAmt xs:decimal

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.

Note: This is not passed in the settlement process.

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

PreferredCustomer optional booleanType Simple Type

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

ConvenienceAmtInfo optional xs:decimal
ShippingAmtInfo optional xs:decimal
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 xs:decimal

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

ReversalAmtInfo optional xs:decimal

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

IncrementalAuthAmtInfo optional xs:decimal

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
TaxAmtInfo optional amtType 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

MultiFulfillmentData optional MultiFulfillmentDataType Complex Type

A collection of transaction of multi-fulfillment related fields

All
CaptureAmtInfo optional amtType 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

CardBrandTxnId optional xs:string

The CardBrandTxnId for this transaction.

All
PaymentFacilitatorTxnId optional xs:string

Unique transaction identifier assigned by the payment facilitator.

PaymentFacilitatorTxnNbr optional xs:string

Unique Sub-merchant account identifier assigned by the payment facilitator.

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.

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.

CurrencyConversion optional CurrConversionDataType Complex Type

Data block for Currency Conversion.

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.

Note:This is for the GNAPUK only.

CardHolderAmt optional amtType Simple Type

The charge amount in the cardholder currency.

ExchangeRateApplied optional exchangeRateType Simple Type

The exchange rate used for currency conversion.

MarkupFee optional amtType Simple Type

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

Valid values include:

  • HSBCIPP
  • mIPP
  • SIP

Note: This field is available to Asia Pacific merchants only.

SIPOptions optional sipOptionsType Simple Type

Optional, sent for SIP only

Valid values include:

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

Note: This field is available to Asia Pacific merchants only.

InstallmentPlan optional installmentPlanType Simple Type

Valid values include:

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

Note: This field is available to Mexico merchants only.

GracePeriod optional gracePeriodType Simple Type

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

Note: This field is available to Mexico merchants only.

NbrInstallments nbrInstallmentsType Simple Type

Number of Installments, 01-99

Note: This field is applicable to both the AP and GSAP hosts.

Source
<xs:element name="ReportTxnDetail" type="PosReportTxnDetailRspType" xmlns:xs="http://www.w3.org/2001/XMLSchema" />
See Also
Transaction ElementVer1.0 ElementPosResponse ElementPortico Schema