Undo a load transaction to a gift card

With an undo request, you can reverse a gift card transaction that loaded funds to a gift card. The amount loaded is taken off the gift card balance. However, you can only undo the most recent load transaction and this transaction must be from the past 24 hours.

You identify the transaction you want to undo by its transaction identifier.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Undo a transaction

To undo the most recent load transaction made in the past 24 hours on a gift card:

1. Get the POITransactionID.TimeStamp and POITransactionID.TransactionID of the original
   transaction.

2. Make a POST request to a Terminal API endpoint,
   specifying:

   • The standard SaleToPOIRequest.MessageHeader object, with MessageClass set to Service and MessageCategory set to StoredValue.

     Parameter	Required	Description
     ProtocolVersion		3.0
     MessageClass		Service
     MessageCategory		StoredValue
     MessageType		Request
     ServiceID		Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
     SaleID		Your unique ID for the POS system component to send this request from.
     POIID		The unique ID of the terminal to send this request to. Format: [device model]-[serial number].

   • StoredValueRequest.SaleData.SaleTransactionID. This includes:

     Parameter	Required	Description
     TransactionID		Your reference to identify this undo request. We recommend using a unique value.
     TimeStamp		date and time of the request, in UTC format.

   • StoredValueRequest.StoredValueData. This includes:

     Parameter	Required	Description
     StoredValueTransactionType		Reverse
     OriginalPOITransaction		The details of the transaction that you want to undo: POITransactionID.TimeStamp: date and time of the original transaction. POITransactionID.TransactionID: transaction identifier of the original transaction, in one of the formats from the table below.

     Format	Example
     tenderReference.pspReference	A7sM001574852436000.NC6HT9CRT65ZGN82 Recommended format
     pspReference	.NC6HT9CRT65ZGN82 Do not forget the leading dot (.).
     tenderReference	A7sM001574852436000 Only when using the same terminal as for the original transaction.

   See the StoredValueRequest API reference.

3. In the StoredValueResponse, check the following:

   • StoredValueTransactionType: Reverse and Response.Result: Success indicate the loaded funds were reversed.

   • In the StoredValueResult object, StoredValueAccountStatus indicates the CurrentBalance remaining on the card after undoing a load request.

   • POIData.POITransactionID.TransactionID: This is Transaction identifier for the undo request.

   • Response.AdditionalResponse: additional transaction data. Depending on the format you used in the request, you receive either a string of form-encoded key-value pairs or a Base64 string that you need to decode to get a JSON object.

   {
     "SaleToPOIResponse":{
       "StoredValueResponse":{
         "POIData":{
           "POITransactionID":{
             "TimeStamp":"2019-03-26T09:31:29.000Z",
             "TransactionID":"pZjO001522056689002.NC6HT9CRT65ZGN82"
           }
         }
         ...,
         "StoredValueResult":[
           {
             "StoredValueTransactionType":"Reverse",
             "StoredValueAccountStatus": {
               "CurrentBalance":265.79
             }
           }
         ],
         "Response":{
           "Result":"Success",
           "AdditionalResponse":"tid=46742566&transactionType=REFUND&backendGiftcardIndicator=false&posAmountGratuityValue=0&giftcardIndicator=true&pspReference=NC6HT9CRT65ZGN82&storedValueApi=true&currentBalanceCurrency=USD&txtime=10%3a27%3a20&iso8601TxDate=2019-12-31T09%3a27%3a20.0000000%2b0000&posOriginalAmountValue=0&txdate=31-12-2019&merchantReference=17322&transactionReferenceNumber=NC6HT9CRT65ZGN82&posadditionalamounts.originalAmountCurrency=EUR&posAuthAmountCurrency=EUR&posAmountCashbackValue=0&posAuthAmountValue=0&currentBalanceValue=26579"
         }
       },
       "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"POSSystemID12345",
         "MessageClass":"Service",
         "MessageCategory":"StoredValue",
         "ServiceID":"9264",
         "POIID":"V400m-324688179",
         "MessageType":"Response"
       }
     }
   }

   See the StoredValueResponse API reference.

See also