Make a referenced partial refund

Outlines using a ReversalRequest to refund part of the value of a transaction to a card.


Referenced partial refunds allow you to refund part of the value of a transaction using a TenderReference or PSP reference.

Endpoint

The URL used to send  Terminal API  messages depends on your type of implementation. For more information on the architectures available, see the Terminal API Overview .

ReversalRequest refund request

For a list of Reversal Request fields, see ReversalRequest fields.

The SaleID and ServiceID in the MessageHeader should be unique. SaleID and ServiceID combinations are rejected if used recently, within 48 hours.

The POITransactionID passed in the request should be a full ID including a tender reference and a PSP reference. Specify the currency of the transaction in SaleToAcquirerData. If SaleData is included, it should also contain a full SaleTransactionID.

{
   "SaleToPOIRequest":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "MessageClass":"Service",
         "MessageCategory":"Reversal",
         "MessageType":"Request",
         "ServiceID":"0629093609",
         "SaleID":"CashRegB3",
         "POIID":"P400Plus-275008565"
      },
      "ReversalRequest":{
         "ReversedAmount":0.1,
         "SaleData":{
            "SaleTransactionID":{
               "TransactionID":"17837",
               "TimeStamp":"2018-06-29T07:36:09+00:00"
            },
            "SaleToAcquirerData":"currency=EUR"
         },
         "ReversalReason":"MerchantCancel",
         "OriginalPOITransaction":{
            "POITransactionID":{
               "TransactionID":"4j9Z001529569582000.9815295695913882",
               "TimeStamp":"2018-06-21T08:26:22.000Z"
            }
         }
      }
   }
}

Response

For a list of Reversal Response fields, see  ReversalResponse fields.
{
   "SaleToPOIResponse":{
      "ReversalResponse":{
         "POIData":{
            "POITransactionID":{
               "TimeStamp":"2018-06-29T07:36:11.000Z",
               "TransactionID":"9815302577723973"
            }
         },
         "ReversedAmount":0.1,
         "Response":{
            "Result":"Success",
            "AdditionalResponse":"currency=EUR"
         }
      },
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "SaleID":"CashRegB3",
         "MessageClass":"Service",
         "MessageCategory":"Reversal",
         "ServiceID":"0629093609",
         "POIID":"P400Plus-275008565",
         "MessageType":"Response"
      }
   }
}