Search

Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

Cancel collecting input

Learn how to cancel an in-progress input request.

While an input request is in progress, you can cancel it in the same way that you can cancel an in-progress payment. You can either:

  • Make an AbortRequest from your cash register.
  • Press the Cancel key on the terminal keypad.

Cancel from cash register

To cancel an InputRequest from your cash register:

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

    • AbortRequest: The request body with:

      Parameter Required Description
      AbortReason -white_check_mark- MerchantAbort
      MessageReference -white_check_mark- An object with:
      • MessageCategory: Input
      • SaleID: Your unique ID of the cash register that made the input request.
      • ServiceID: The ServiceID of the input request being cancelled.

    For more details see the AbortRequest API reference.

    The example below shows how you would make a request to cancel an in-progress input request with a ServiceID of 21796.

    AbortRequest to cancel an InputRequest
    {
       "SaleToPOIRequest":{
          "MessageHeader":{
             "ProtocolVersion":"3.0",
             "MessageClass":"Service",
             "MessageCategory":"Abort",
             "MessageType":"Request",
             "SaleID":"POSSystemID12345",
             "ServiceID":"29239",
             "POIID":"V400m-324688179"
          },
          "AbortRequest":{
             "AbortReason":"MerchantAbort",
             "MessageReference":{
                "MessageCategory":"Input",
                "SaleID":"POSSystemID12345",
                "ServiceID":"21796"
             }
          }
       }
    }

    A successful AbortRequest returns a response with a 200 OK HTTP status code and no body.

  2. Check whether cancelling was successful:

    • The screen generated by your InputRequest disappears from the terminal display.
    • The InputRequest returns a response containing:
      • Result: Failure
      • ErrorCondition: Aborted

    The following example shows the response for a confirmation input request that was cancelled.

    InputResponse after cancelling the InputRequest
    {
        "SaleToPOIResponse": {
            "InputResponse": {
                "InputResult": {
                    "Device": "CustomerInput",
                    "InfoQualify": "Input",
                    "Response": {
                        "Result": "Failure",
                        "ErrorCondition": "Aborted"
                    },
                    "Input": {
                        "InputCommand": "GetConfirmation"
                    }
                },
                "OutputResult": {
                    "Device": "CustomerDisplay",
                    "InfoQualify": "Display",
                    "Response": {
                        "Result": "Success"
                    }
                }
            },
            "MessageHeader": {
                "ProtocolVersion": "3.0",
                "SaleID": "POSSystemID12345",
                "MessageClass": "Device",
                "MessageCategory": "Input",
                "ServiceID": "010",
                "POIID": "V400m-324688179",
                "MessageType": "Response"
            }
        }
    }

Cancel from terminal

To cancel an in-progress input request from a terminal:

  • Press the Cancel key on the terminal keypad.

If this is successful:

  • The screen generated by your InputRequest disappears from the terminal display.
  • The InputRequest returns a response. Depending on the type of input, this InputResponse contains:

    Type of input Result ConfirmedFlag
    Confirmation Success false
    Signature Success false
    Type of input Result ErrorCondition
    Menu Failure Cancel
    Digit Failure Cancel
    Text Failure Cancel

See also