giftCardResponse
The giftCardResponse
element is a required child of several transaction types and optional for several others. Through its child elements, it provides details about the available balance on a Gift Card, as well as additional reference items used in subsequent, related transactions. For example, in a giftCardAuthReversal
transaction, you must include values of the refCode
, systemTraceId
, and sequenceNumber
from the authorizationResponse
in the originalRefCode
, originalSystemTraceId
, and originalSequenceNumber
elements respectively.
Parent Elements:
Required: activateResponse, activateReversalResponse, giftCardAuthReversalResponse, balanceInquiryResponse, giftCardCaptureResponse, giftCardCreditResponse, deactivateResponse, deactivateReversalResponse, depositReversalResponse, loadResponse, loadReversalResponse, refundReversalResponse, unloadResponse, unloadReversalResponse
Optional (per schema, but always returned for Gift Card Transactions): authorizationResponse, captureGivenAuthResponse, forceCaptureResponse, saleResponse
Attributes:
None
Child Elements (All Optional, but must contain at least one child):
Optional: txnTime, refCode, systemTraceId, sequenceNumber, availableBalance, beginningBalance, endingBalance, cashBackAmount
Although included in the schema, the beginningBalance
, endingBalance
, and cashBackAmount
elements are not currently supported.
Example: giftCardResponse Structure
<giftCardResponse>
<txnTime>2016-11-15T12:00:00</txnTime>
<refCode>abc123</refCode>
<systemTraceId>123456</systemTraceId>
<sequenceNumber>123456</sequenceNumber>
<availableBalance>Balance Available on Gift Card</availableBalance>
</giftCardResponse>