PosRewardCashRedeemReqType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

PosRewardCashRedeemReqType

All

Block1 RewardCashRedeemBlock1Type Complex Type

RewardCashRedeem is used to redeem available reward points for a participating account. These authorizations are automatically added to the reward cash batch to be settled.

If a batch is not already open this transaction will create one.

Note: Allowed for Reward Cash terminals configured for the Asia Pacific region only.

Note: This transaction is for Future Use.

All

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

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.

Amt amtTypeGlobal Simple Type

The total number of points to redeem for Items in RedeemDetails block.

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.

RedemptionData RedemptionDataType Complex Type

All

RedeemItemDetails optional

CashDiscountUsed optional CashDiscountType Simple Type

Used By

RewardCashRedeem Element

Source

<xs:complexType name="PosRewardCashRedeemReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="Block1" type="RewardCashRedeemBlock1Type">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">RewardCashRedeem is used to redeem available reward points for a participating account. These authorizations are automatically added to the reward cash batch to be settled.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">If a batch is not already open this transaction will create one.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> Allowed for Reward Cash terminals configured for the Asia Pacific region only.
            </p>
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> This transaction is for Future Use.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>