FindTransactionsRspType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

FindTransactionsRspType

Sequence

Transactions 0..∞ TransactionDataType Complex Type

The result set of the search

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

ClientTxnId clientIdType Simple Type

GatewayRspCode xs:int

Gateway response code (issuer is separate)

GatewayRspMsg xs:string

Gateway response message

CardType xs:string

MaskedCardNbr optional 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.

CardSwiped xs:string

Indicates whether or not the payment method from the original transaction was swiped

CardHolderData optional CardHolderDataType Complex Type

Card holder data

All

CardHolderFirstName optional firstNameType Simple Type

First name

CardHolderLastName optional lastNameType Simple Type

Last name

CardHolderAddr optional addrType Simple Type

Address

CardHolderCity optional cityType Simple Type

City

CardHolderState optional stateType Simple Type

State

CardHolderZip optional zipType Simple Type

Zip or postal code; see the associated Type pattern for restrictions.

Note: Canadian postal codes should be sent in the format "A0A0A0".

CardHolderPhone optional phoneType Simple Type

Phone number; see the associated Type pattern for restrictions.

CardHolderEmail optional emailType Simple Type

Email address

CardHolderLanguage optional languageIndicatorType Simple Type

CardHolder preferred language.

Note:This field is required for Canadian merchants.

PaymentType paymentTypeType Simple Type

This will be based on the original request; see the associated Type enumerations for specific values supported.

ServiceName xs:string

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

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'

AuthCode optional xs:string

Amt amtTypeGlobal Simple Type

The original requested amount

AuthAmt optional amtTypeGlobal Simple Type

The actual authorized amount

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

SettlementAmt amtTypeGlobal Simple Type

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

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

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

GratuityAmtInfo optional amtTypeGlobal Simple Type

UserName userNameType Simple Type

ClerkID optional Restriction of xs:string

RspDT xs:dateTime

Transaction response date time in the time zone conversion requested

RspCode optional xs:string

Issuer response code

RspText optional xs:string

Issuer response text

IssTxnId optional xs:string

Issuer transaction identifier

RefNbr optional xs:string

BatchSeqNbr optional xs:int

BatchCloseDT optional xs:dateTime

Batch close date time in the time zone conversion requested. If the transaction is in open batch value is nil.

SiteTrace optional xs:string

OriginalGatewayTxnId optional txnIdType Simple Type

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

AcctDataSrc optional 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.

CPCData optional CPCDataType Complex Type

All

CardHolderPONbr optional cardHolderPONbrType Simple Type

Purchase order number

TaxType optional taxTypeType Simple Type

Tax type indicator that qualifies the associated tax amount, see the associated Type enumerations for specific values supported.

TaxAmt optional amtTypeGlobal Simple Type

Tax amount

Note: If the tax type is 'TaxExempt', an amount should not be provided. If it is, the gateway discards the amount.

SalesTaxDetails optional SalesTaxDetailsType Complex Type

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

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

PreferredCustomer optional booleanType Simple Type

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

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

UniqueDeviceId optional xs:string

ConvenienceAmtInfo optional amtTypeGlobal Simple Type

ShippingAmtInfo optional amtTypeGlobal Simple Type

TxnDescriptor optional xs:string

CheckData optional CheckDataType Complex Type

A collection of check transaction related fields

All

AccountInfo optional AccountInfoType Complex Type

Account information

ConsumerInfo optional ConsumerInfoType Complex Type

Consumer information

DataEntryMode optional dataEntryModeType Simple Type

CheckType optional checkTypeType Simple Type

SECCode optional xs:string

CheckAction checkActionType Simple Type

AttachmentInfo 0..4 AttachmentInfoType Complex Type

Information regarding attachments associated with 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

GiftCurrency optional currencyType Simple Type

GiftMaskedAlias optional Restriction of xs:string

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

TaxAmtInfo optional amtTypeGlobal Simple Type

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

CashData optional CashDataType Complex Type

A collection of cash transaction related fields

All

TaxAmtInfo optional amtTypeGlobal Simple Type

FraudRuleInfo optional xs:string

Comma-separated list of strings containing the ID or description of the fraud rule that triggered the fraud decline. Only applies to authorizations that were declined due to fraud.

Note: This is for internal use only.

RepeatCount optional xs:int

For fraud declines indicates how many times the transaction has been overridden. Max is 1, so essentially, this indicates if the fraud decline result was overridden. Only applies to authorizations that were declined due to fraud.

Note: This is for internal use only.

EMVChipCondition optional xs:string

HasEMVTag optional xs:string

Indicates whether or not EMVTags were sent on this transaction; 'Y' indicates that EMV were sent, 'N' indicates that they were not.

HasEComPaymentData optional xs:string

Indicates whether or not Secure ECommerce Payment Data was sent on this transaction; 'Y' indicates that it did and 'N' that it did not.

CAVVResultCode optional xs:string

The Visa Cardholder Authentication Verfication Value results code. This is returned by Visa when using SecureECommerce.

TokenPANLast4 optional xs:string

Last 4 digits of PAN associated with Token. This may be returned by 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 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

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.

x_global_transaction_id optional x_global_transaction_idType Simple Type

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.

ProcessedSiteId optional siteIdType Simple Type

Site identifier used to process the request.

ProcessedDeviceId optional deviceIdType Simple Type

Device identifier used to process the request.

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.

HasLevelIII optional booleanType Simple Type

Specify if transaction has L3 data

SAFData optional SAFDataType Complex Type

Specify if transaction was initiated in "store and forward" (SAF) mode (Y).

If SAFData block is present, SAFIndicator is required.

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.

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.

AccountReference optional xs:string

'Payment Account Reference' (PAR) data returned by issuer. PAR is 29-character alphanumeric reference number associated with each unique PAN and used by merchants to track transactions associated with customers PAN. Currently, PAR is only supported by Card Brand American Express.

Note: Account Reference is supported only for HOST Exchange.

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.

TzConversion optional tzoneConversionType Simple Type

Indicates the time zone conversion applied to dates/times in the response; see the associated Type enumerations for specific values supported.

Used By

FindTransactions Element

Source

<xs:complexType name="FindTransactionsRspType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element name="Transactions" type="TransactionDataType" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The result set of the search</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:element>
    <xs:element name="TzConversion" type="tzoneConversionType" default="Merchant" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates the time zone conversion applied to dates/times in the response; see the associated Type enumerations for specific values supported.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>