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

GiftCardVoid is used to cancel a prior successful transaction. When voiding a transaction, all changes to the account are reversed, including any additional value added by rewards programs or automated promotions.

This can be used on prior transactions of the following types:

  • GiftCardActivate
  • GiftCardAddValue
  • GiftCardDeactivate
  • GiftCardReplace
  • GiftCardSale
  • GiftCardReward

Note: Only the most recent transaction is allowed to be referenced as the prior transaction for a gift void. For example, if an activate is run and then an add value is run, only the add value can be voided.

Namespace http://Hps.Exchange.PosGateway
Type
PosGiftCardVoidReqType Complex Type
Diagram
Block1 Element All GiftCardVoid Element
Overview
GiftCardVoid PosGiftCardVoidReqType Complex Type

GiftCardVoid is used to cancel a prior successful transaction. When voiding a transaction, all changes to the account are reversed, including any additional value added by rewards programs or automated promotions.

This can be used on prior transactions of the following types:

  • GiftCardActivate
  • GiftCardAddValue
  • GiftCardDeactivate
  • GiftCardReplace
  • GiftCardSale
  • GiftCardReward

Note: Only the most recent transaction is allowed to be referenced as the prior transaction for a gift void. For example, if an activate is run and then an add value is run, only the add value can be voided.

All
Block1 GiftCardVoidReqBlock1Type Complex Type

Contains a series of required and optional elements

All
GatewayTxnId txnIdType Simple Type

Gateway-generated transaction identifier returned in the response of the original transaction. This indicates the transaction to be updated.

Source
<xs:element name="GiftCardVoid" type="PosGiftCardVoidReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">GiftCardVoid is used to cancel a prior successful transaction. When voiding a transaction, all changes to the account are reversed, including any additional value added by rewards programs or automated promotions.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">
                            This can be used on prior transactions of the following types:
                            <ul><li>GiftCardActivate</li><li>GiftCardAddValue</li><li>GiftCardDeactivate</li><li>GiftCardReplace</li><li>GiftCardSale</li><li>GiftCardReward</li></ul></p>
      <p xmlns="http://Hps.Exchange.PosGateway" />
      <p xmlns="http://Hps.Exchange.PosGateway">
        <strong>Note:</strong> Only the most recent transaction is allowed to be referenced as the prior transaction for a gift void. For example, if an activate is run and then an add value is run, only the add value can be voided.
                          </p>
    </xs:documentation>
  </xs:annotation>
</xs:element>
See Also
Transaction ElementVer1.0 ElementPosRequest ElementPosGateway Schema