Point-of-sale icon

Ask for a signature

Use an input request to ask a shopper to provide their signature.

Here we describe how you can use an InputRequest to show a prompt on the payment terminal asking the shopper to confirm something by drawing their signature on the display.

The following illustrations show a signature screen on a portrait, small portrait (e285p), and landscape display.

Using the on-screen buttons, the shopper can cancel, clear, or confirm their signature.

On some terminal models, you can include additional text below the header, for example, to explain why you are asking the shopper for their signature. On M400, e280, and e285p terminals, the additional text is ignored.

The terminal continues to show your input request until one of these events occurs:

  • The user has provided input.
  • The maximum input time expires. You can set this time in the request.
  • On the terminal, Cancel is selected.
  • The terminal receives a request to cancel collecting input or any other request from the POS app.

Make a Signature input request

To use the payment terminal to ask a shopper to provide their signature:

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

    • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. Specify:

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Device
      MessageCategory -white_check_mark- Input
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- 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 -white_check_mark- Your unique ID for the system where you send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
    • InputRequest.DisplayOutput to define what is shown on the terminal:

      Parameter Description
      Device CustomerDisplay
      InfoQualify Display
      OutputContent.OutputFormat Text
      OutputContent.PredefinedContent.ReferenceID GetSignature
      OutputContent.OutputText An array of two Text fields containing your own text to show on the terminal:
      1. The header. On a portrait display, this is limited to about 20 characters.
      2. Use an empty value, or specify additional text.
        On M400, e280, and e285 terminals terminals, additional text is ignored, but you still need to include the second Text field with an empty value.
    • InputRequest.InputData to handle the user input:

      Parameter Description
      Device CustomerInput
      InfoQualify Input
      InputCommand GetConfirmation
      MaxInputTime (Integer) Time-out in seconds. This is the time that the user gets to finish their input.

    The following example asks the shopper for their signature.

    For a complete list of fields you can pass in a GetSignature input request, see the API reference.

  2. Wait for the user to supply the requested input.

    The provided input is not validated against a format.

    • If input is received from the terminal, the InputResponse has an InputResult with:
      • Response.AdditionalResponse: the signature provided by the shopper.
      • Input.ConfirmedFlag: true indicates the shopper confirmed their agreement by selecting Confirm .
      • Input.ConfirmedFlag: false means the shopper declined by selecting Cancel .
    • If the input request times out, the InputResult.Response has AdditionalResponse: message=Screen%20timeout, Result: Failure, and ErrorCondition: Cancel.

    • If you make a payment request while the input request is waiting for input on the terminal, the payment request overrides the input request. The InputResult.Response has AdditionalResponse: message=A%20higher%20priority%20request%20has%20been%20received, Result: Failure, and ErrorCondition: Busy.

    For a complete list of fields you can receive in a GetSignature input response, see the API reference.

  3. Pass the relevant data from InputResult.Input to your system for validation and further use.

See also