SurchargeEligibilityLookup Element

Description

SurchargeEligibilityLookup allows merchants to verify if surcharge can be applied to the card data supplied.

Namespace

http://Hps.Exchange.PosGateway

Type

PosSurchargeEligibilityLookupReqType Complex Type

Diagram

Overview

SurchargeEligibilityLookup PosSurchargeEligibilityLookupReqType Complex Type

SurchargeEligibilityLookup allows merchants to verify if surcharge can be applied to the card data supplied.

All

Block1 SurchargeEligibilityLookupBlock1Type Complex Type

Contains a series of required and optional elements.

All

CardData optional CardDataType Complex Type

A common element used in several different transactions for supplying payment method information.

This includes a choice of typical payment representations like track data, manually entered data, and token information. It also includes options for specifying how the supplied data has been encrypted or to request a multi-use token be supplied in the response.

Sequence

Choice

TrackData CardDataTypeTrackData Complex Type

Track data is the full magnetic stripe data.

Note: TrackData is unique in that it has an attribute "method" that is used to indicate how the associated data was obtained.

ManualEntry

This is typically manually entered card data, but can be used in any case where only the card number is used rather than the full track.

TokenData

This is used when the card number from a previous transaction has been tokenized. This supports both multi-use and single-use tokens.

EncryptionData optional EncryptionDataType Complex Type

If the supplied card data was encrypted, this must be supplied.

TokenRequest optional booleanType Simple Type

This is used to request the gateway to return a multi-use token for the supplied card data. If a token is provided in the card data and this flag is set, it will be echoed in the response.

TokenParameters optional TokenParametersType Complex Type

Parameters allowing the client to control aspects of how a requested multi-use token is generated.

Not Applicable for Reward Cash transactions.

PaymentMethodKey optional guidType Simple Type

Unique key generated by PayPlan associated with a stored payment method

Note: When using a key, card data should not be sent. However, stored customer data can be overridden using the card holder 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.

Source

<xs:element name="SurchargeEligibilityLookup" type="PosSurchargeEligibilityLookupReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">SurchargeEligibilityLookup allows merchants to verify if surcharge can be applied to the card data supplied.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>