GiftCardActivate Element

Description

GiftCardActivate is used to activate a new stored value account and load it with an initial balance. If the specified stored value account is already active, the request will fail.

Note: Stored value accounts can also be activated implicitly via the GiftCardAddValue method depending on the platform configuration for a customer's specific program.

Note: This method supports loyalty points.

Namespace

http://Hps.Exchange.PosGateway

Type

PosGiftCardActivateReqType Complex Type

Diagram

Overview

GiftCardActivate PosGiftCardActivateReqType Complex Type

GiftCardActivate is used to activate a new stored value account and load it with an initial balance. If the specified stored value account is already active, the request will fail.

Note: Stored value accounts can also be activated implicitly via the GiftCardAddValue method depending on the platform configuration for a customer's specific program.

Note: This method supports loyalty points.

All

Block1 GiftCardActivateReqBlock1Type 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 amount of the initial balance to load onto the card during the activation

Currency optional currencyType Simple Type

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

AllowDup optional booleanType Simple Type

This is important in cases where the client processes a large number of similar transactions in a very short period of time; sending "Y" will skip duplicate checking on this transaction

AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type

A common group of optional fields that are supported in several different transaction types for Merchant use.

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.

Source

<xs:element name="GiftCardActivate" type="PosGiftCardActivateReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">GiftCardActivate is used to activate a new stored value account and load it with an initial balance. If the specified stored value account is already active, the request will fail.</p>
      <p xmlns="http://Hps.Exchange.PosGateway" />
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong> Stored value accounts can also be activated implicitly via the GiftCardAddValue method depending on the platform configuration for a customer's specific program.
                          </p>
      <p xmlns="http://Hps.Exchange.PosGateway" />
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong> This method supports loyalty points.
                          </p>
    </xs:documentation>
  </xs:annotation>
</xs:element>