GiftCardReward Element

Description

GiftCardReward is used when an account holder makes a payment using a payment form other than a stored value account (e.g. cash or credit card). The account holder may present their stored value account to earn points or other loyalty rewards, which would be added to their account. If successful, the rewarded amount is returned in the response.

Note: This transaction is not used for purchases. Instead, the purchase amount is used to help determine what potential rewards may be added based on the merchant's loyalty and rewards program.

Namespace

http://Hps.Exchange.PosGateway

Type

PosGiftCardRewardReqType Complex Type

Diagram

Overview

GiftCardReward PosGiftCardRewardReqType Complex Type

Note: This transaction is not used for purchases. Instead, the purchase amount is used to help determine what potential rewards may be added based on the merchant's loyalty and rewards program.

All

Block1 GiftCardRewardReqBlock1Type Complex Type

Contains a series of required and optional elements

All

CardData GiftCardDataType Complex Type

A common element used in stored value transactions for supplying payment method information

This includes a choice of typical payment representations like track data, card number, alias, and token information. It also includes options for specifying how the supplied data has been encrypted.

Sequence

Choice

TrackData trackDataType Simple Type

Track data is the full magnetic stripe data.

CardNbr cardNbrType Simple Type

Stored value account number

Alias Restriction of xs:string

An alternate identifier previously assigned to the stored value account.

TokenValue Restriction of xs:string

Token used to replace card data for this transaction.

Note: Multi-use tokens are not supported on gift transactions. This is currently only used for single-use tokens. Single-use tokens are provided by the SecureSubmit product and are primarily used in eCommerce situations.

EncryptionData optional EncryptionDataType Complex Type

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

PIN optional Restriction of pinType Simple Type

A numeric PIN associated with the stored value account.

Note: This is not a PIN block as defined in debit transactions.

Amt amtTypeGlobal Simple Type

The purchase amount of the previous transaction to use for rewards calculation; this includes all other "Info" amounts provided as part of this request

Currency optional currencyType Simple Type

Identifies the currency of the transaction amount; see the associated Type enumerations for specific values supported

GratuityAmtInfo optional amtTypeGlobal Simple Type

Gratuity amount information; this defines the portion of the total amount provided as part of this request that was specifically for gratuity. This is informational only and will not alter the amount processed as part of the transaction.

TaxAmtInfo optional amtTypeGlobal Simple Type

Tax amount information; this defines the portion of the total amount provided as part of this request that was specifically for tax. This is informational only and will not alter the amount processed as part of the transaction.

Source

<xs:element name="GiftCardReward" type="PosGiftCardRewardReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">GiftCardReward is used when an account holder makes a payment using a payment form other than a stored value account (e.g. cash or credit card). The account holder may present their stored value account to earn points or other loyalty rewards, which would be added to their account. If successful, the rewarded amount is returned in the response.</p>
      <p xmlns="http://Hps.Exchange.PosGateway" />
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong> This transaction is not used for purchases. Instead, the purchase amount is used to help determine what potential rewards may be added based on the merchant's loyalty and rewards program.
                          </p>
    </xs:documentation>
  </xs:annotation>
</xs:element>