1. Home
  2. Docs
  3. API
  4. getUserInput


This method will prompt the user in front of a terminal to enter some information. The “Title” field is used as the prompt, i.e., Enter the tip amount or enter your phone number.  On Pax devices, the value of the title field has to match predefined options specified by Pax. Please contact us for a current list.

The type is the allowed entry characters:
c=currency (Response will NOT have a decimal place included)
n=numeric only
a=alpha only

maxlength=number of characters to limit the user entry to

HTTP Request


JSON Response (standard transaction response fields)


How can we help?