Reversal

Message category	Class	Direction
`Reversal`	Service	ECR → terminal

📘
Used in these guides
Make a payment · Generate receipts · Reverse a payment

Manual (by cashier) reversal of last transaction.

Example request and response

reversal

All fields

Example request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "4",
      "MessageClass": "Service",
      "MessageCategory": "Reversal",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "ReversalRequest": {
      "OriginalPOITransaction": {
        "POITransactionID": {
          "TransactionID": "542952"
        }
      },
      "ReversalReason": "MerchantCancel"
    }
  }
}

Field	Required	Description
`ReversalRequest`	Required	Contains the fields below
↳ `OriginalPOITransaction`	Required	Contains the fields below
↳ `POITransactionID`	Required	Contains the fields below
↳ `TransactionID`	Required	Transaction ID of transaction to be aborted.
↳ `ReversalReason`	Required	Reason for reversal. Used for logging purposes

Example response

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "MessageCategory": "Reversal",
      "MessageClass": "Service",
      "MessageType": "Response",
      "POIID": "AT12345",
      "ProtocolVersion": "3.1",
      "SaleID": "ECR123",
      "ServiceID": "4"
    },
    "ReversalResponse": {
      "Response": {
        "Result": "Success"
      },
      "PaymentReceipt": [
        {
          "DocumentQualifier": "CustomerReceipt",
          "OutputContent": {
            "OutputFormat": "Text",
            "OutputText": [
              {
                "Text": "Receipt text 1"
              },
              {
                "Text": "Receipt text 2"
              },
              {
                "Text": "Receipt text 3"
              }
            ]
          }
        }
      ]
    }
  }
}

Field	Required	Description
`ReversalResponse`	Required	Contains the fields below
↳ `Response`	Required	Contains the fields below
↳ `Result`	Required	Success or Failure
↳ `PaymentReceipt`	Optional	Receipt data
↳ `DocumentQualifier`	Required	Enum: CashierReceipt
↳ `OutputContent`	Required	Contains the fields below
↳ `OutputFormat`	Required	Enum: Text
↳ `OutputText`	Required