Terminal-2 icon

Ask for amount input

Use an input request to ask a shopper to enter an amount.

Here we describe how you can use an InputRequest to ask the customer to enter an amount. For example, the amount they want to pay when splitting the bill. The terminal shows the currency and a placeholder amount with two decimals.

The next illustrations show the amount input screen on a portrait and landscape display.

The following illustrations show the amount input screen on a small portrait display (e285) and a portrait display without a keypad (e280).

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.

Entering an amount

As the customer enters their input, the amount is populated from right to left. For example, when the customer selects 3, 6, 5, and 9 to enter an amount of EUR 36.59, the screen changes from a placeholder amount of EUR 0.00 to EUR 0.03, to EUR 0.36 and so on.

Currency

By default, the currency is set to the first one specified for your store in the Customer Area. To check your settings, go to In-person payments > Stores, select your store, and go to Payment features.
If you use a merchant account to represent a physical store, it is the first currency defined for the merchant account in your Customer Area under In-person payments > Terminal settings > Payment features.

Make an Amount input request

To use the payment terminal to ask for an amount input:

  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: this part of the request body defines what is shown on the terminal.

      Parameter Description
      Device CustomerDisplay
      InfoQualify Display
      OutputContent.OutputFormat Text
      OutputContent.PredefinedContent.ReferenceID GetAmount
      OutputContent.OutputText An array of one Text field containing your own text to show on the terminal. On a portrait display, limited to about 20 characters. Apart from the text you specify, the terminal will show the currency and an instruction for how to confirm the input.

    • InputRequest.InputData: this part of the request body handles the user input.

      Parameter Description
      Device CustomerInput
      InfoQualify Input
      InputCommand DecimalString
      MaxInputTime (Integer) Time-out in seconds. This is the time that the user gets to finish their input.
      DefaultInputString Placeholder text for the input box, to let the user know what input format you are expecting. For example: 0.00

    This example asks the shopper to enter the amount they want to pay.

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

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

    • If input is received from the terminal, the InputResult.Input contains:
      • DigitInput: the amount that the user entered.

    • 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.

    • If the user declined to respond (selected the Cancel key ), the InputResult.Input.DigitInput field is empty. The InputResult.Response has Result: Failure and ErrorCondition: Cancel.

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

  3. Pass the DigitInput value to your system for validation and further use.

See also