FindTransactionsReqType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

FindTransactionsReqType

All

Criteria optional SearchCriteriaType Complex Type

If the client does not have the associated transaction id or needs to search for multiple transactions, these filters can be applied.

Any transactions returned will match all criteria provided. Each filter is an exact match unless otherwise stated.

Note: Clients should make every effort to minimize the result set from a search. Breaking a search into parts based on date is a great way to do this. Response timeouts should also be adjusted accordingly as a search should not be expected to return in the same time as a transaction.

Sequence optional

StartUtcDT optional xs:dateTime

Start date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, start date time will be defaulted to six days prior at 00:00:00.

Transactions must have been run at or after this time to be returned.

EndUtcDT optional xs:dateTime

End date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, start date time will be defaulted to tomorrow at 00:00:00.

Transactions must have been run before or at this time to be returned.

Note: The end date/time must be after the start date/time.

AuthCode optional authCodeType Simple Type

A specific authorization code

CardHolderLastName optional lastNameType Simple Type

The supplied string must appear somewhere in the last name of the associated card holder.

CardHolderFirstName optional firstNameType Simple Type

The supplied string must appear somewhere in the first name of the associated card holder.

CardNbrFirstSix optional Restriction of xs:string

The card number must start with this string.

CardNbrLastFour optional Restriction of xs:string

The card number must end with this string.

InvoiceNbr optional Restriction of xs:string

A specific invoice number; originally supplied in AdditionalTxnFields or DirectMktInvoiceNbr in DirectMktData

CardHolderPONbr optional Restriction of cardHolderPONbrType Simple Type

A specific purchase order number; originally supplied in a CPCEdit

CustomerID optional customerIDType Simple Type

A specific customer id; originally supplied in AdditionalTxnFields

ServiceName 0..15 Restriction of serviceNameType Simple Type

A list of transaction types to search for (i.e. CreditSale); see the associated Type enumerations for specific values supported.

Note: If not supplied, 'all' is assumed.

PaymentType 0..2 paymentTypeType Simple Type

A list of payment methods to search for (i.e. Credit, Debit, etc.); see the associated Type enumerations for specific values supported.

Note: If not supplied, 'all' is assumed.

CardType 0..8 CardTypeType Simple Type

A list of card types to search for (i.e. VISA, MC, etc.); see the associated Type enumerations for specific values supported.

Note: If not supplied, 'all' is assumed.

IssuerResult optional Restriction of xs:string

A specific resulting status based on the issuer response:

F - full approvals
P - partial approvals
A - all approvals (full and partial)
D - declines
FR - fraud declines

Note: If not sent then all will be included.

SettlementAmt optional amtTypeGlobal Simple Type

A specific settlement amount

IssTxnId optional xs:string

A specific issuer transaction identifier

RefNbr optional xs:string

A specific retrieval reference number

UserName optional userNameType Simple Type

A specific user name

ClerkID optional Restriction of xs:string

A specific clerk id

BatchSeqNbr optional xs:int

A specific batch sequence number

BatchId optional batchIdType Simple Type

A specific batch id

SiteTrace optional siteTraceType Simple Type

A specific site trace

DisplayName optional Restriction of xs:string

A specific user display name

Note: This field is for future use and is ignored.

ClientTxnId optional clientIdType Simple Type

A specific client-generated transaction id

Note: Since this value should be unique, this should find at most one match.

UniqueDeviceId optional uniqueDeviceIdType Simple Type

A specific client-generated device sub-identifier

AcctNbrLastFour optional Restriction of xs:string

The check account number must end with this string

BankRoutingNbr optional Restriction of xs:string

A specific routing number

CheckNbr optional Restriction of xs:string

A specific check number

CheckFirstName optional Restriction of xs:string

A specific first name on the check

CheckLastName optional Restriction of xs:string

A specific last name on the check

CheckName optional Restriction of xs:string

A specific business name on the check

GiftCurrency optional currencyType Simple Type

A specific type of gift currency; see the associated Type enumerations for specific values supported

Note: If not supplied, 'all' is assumed.

GiftMaskedAlias optional Restriction of xs:string

A specific gift card alias

OneTime optional booleanType Simple Type

Search for only card-on-file, one-time payments; the default is N.

PaymentMethodKey optional guidType Simple Type

A specific PayPlan payment method key

ScheduleID optional scheduleIDType Simple Type

A specific schedule ID

BuyerEmailAddress optional Restriction of xs:string

A buyer's email address

AltPaymentStatus optional Restriction of xs:string

A payment status of Altpayment transaction

FullyCapturedInd optional booleanType Simple Type

Fully Captured Indicator for searching for Altpayment Transactions; the default is null.

CardBrandTxnId optional restrictedStringType Simple Type

The CardBrandTxnId associated with the original and/or subsequent Card/Credential on File transactions.

SiteId optional siteIdType Simple Type

The Site identifier to query.

Note: The Site must belong to the same License as the requesting Site and Device. The Device identifier must also be specified. The Merchant must be enabled for this functionality.

DeviceId optional deviceIdType Simple Type

The Device identifier to query.

Note: The Device must belong to the Site in the request header or request body if used. The Merchant must be enabled for this functionality.

SAFIndicator optional booleanType Simple Type

Indicator for searching transactions that were processed and initiated in "store and forward" (SAF) mode.

CurrencyOptOutFlag optional booleanType Simple Type

Search for currency conversion transactions where the user opted in or out; the default is null.

TzConversion optional tzoneConversionType Simple Type

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

TxnId optional txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction. This indicates a specific transaction to be returned.

If supplied, the search will return a single record unless used in conjunction with FindHistoryInd. Otherwise, any other criteria is ignored.

Note: This is the value referred to as GatewayTxnId in other messages.

FindHistoryInd optional booleanType Simple Type

Indicates whether to return any subsequent transactions associated with the Gateway-generated transaction identifier supplied.

Note: This will be ignored if the TxnId is not supplied.

x_global_transaction_id optional x_global_transaction_idType Simple Type

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

Note: This is for internal use only.

Used By

FindTransactions Element

Source

<xs:complexType name="FindTransactionsReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="Criteria" type="SearchCriteriaType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">If the client does not have the associated transaction id or needs to search for multiple transactions, these filters can be applied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Any transactions returned will match all criteria provided. Each filter is an exact match unless otherwise stated.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Clients should make every effort to minimize the result set from a search. Breaking a search into parts based on date is a great way to do this. Response timeouts should also be adjusted accordingly as a search should not be expected to return in the same time as a transaction.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TzConversion" type="tzoneConversionType" default="UTC" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates that a time zone conversion should be applied to dates/times in the response; see the associated Type enumerations for specific values supported.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TxnId" type="txnIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Gateway-generated transaction identifier returned in the response of the original transaction. This indicates a specific transaction to be returned.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If supplied, the search will return a single record unless used in conjunction with FindHistoryInd.  Otherwise, any other criteria is ignored.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This is the value referred to as GatewayTxnId in other messages.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="FindHistoryInd" type="booleanType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates whether to return any subsequent transactions associated with the Gateway-generated transaction identifier supplied.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This will be ignored if the TxnId is not supplied.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="x_global_transaction_id" type="x_global_transaction_idType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Client generated transaction identifier sent in the request of the original transaction. This indicates the transaction to be retrieved.</p>
          <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:all>
</xs:complexType>