Open the Portico Developer Guide site
PosGateway Schema
GiftCardReplace Element
PosGateway Schema > PosRequest Element > Ver1.0 Element > Transaction Element : GiftCardReplace Element
Description

GiftCardReplace transfers balances from one stored value account to another. This is typically to replace a lost or stolen account with a new one or to consolidate two or more accounts into a single account. After a transfer has completed, the source account is closed/deactivated and can no longer be used. The balance for the destination account is returned in the response.

Namespace http://Hps.Exchange.PosGateway
Type
PosGiftCardReplaceReqType Complex Type
Diagram
Block1 Element All GiftCardReplace Element
Overview
GiftCardReplace PosGiftCardReplaceReqType Complex Type

GiftCardReplace transfers balances from one stored value account to another. This is typically to replace a lost or stolen account with a new one or to consolidate two or more accounts into a single account. After a transfer has completed, the source account is closed/deactivated and can no longer be used. The balance for the destination account is returned in the response.

All
Block1 GiftCardReplaceReqBlock1Type Complex Type

Contains a series of required and optional elements

All
OldCardData GiftCardDataType Complex Type

This is the account that is no longer desired. Information will be moved from this account to the new account.

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.

NewCardData GiftCardDataType Complex Type

This is the desired account. Information will be moved to this account from the old account.

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.

Source
<xs:element name="GiftCardReplace" type="PosGiftCardReplaceReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">GiftCardReplace transfers balances from one stored value account to another. This is typically to replace a lost or stolen account with a new one or to consolidate two or more accounts into a single account. After a transfer has completed, the source account is closed/deactivated and can no longer be used. The balance for the destination account is returned in the response.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>
See Also
Transaction Element | Ver1.0 Element | PosRequest Element | PosGateway Schema

 

 

© 2024 Heartland Payment Systems, Inc.