This endpoint allows the client to display a prompt on the PIN pad and accept cardholder input through the keypad.
triPOS has a set of predefined prompts and formats from which the client can choose. The client must send the selected promptType
and formatType as query parameters on the request.
If the client does not specify a formatType, triPOS will apply a default formatType for each promptType.
NOTE: Not all devices support all promptTypes or formatTypes. Please see the table below for more details.
IMPORTANT NOTE: For the PIN pads that support formatting, no matter which format is applied, the format only affects how the input is displayed to the cardholder on the PIN pad's screen. triPOS will always return
ONLY the raw input of the cardholder, not the formatted input. This means that if the formatType is AmountWithDollarCommaDecimal, which is the most common formatType for an amount,
and cardholder enters '100' which is displayed on the PIN pad as $ 1.00, triPOS will return only the buttons pressed by the cardholder, which would be "100".
It is up to the client to determine the true value that the cardholder entered by applying the correct format to the returned text. In the example above, the cardholder sees the value as $1.00
on the PIN pad, so when triPOS returns "100", the client needs to determine by the formatType of AmountWithDollarCommaDecimal that the actual value entered is $1.00. The
client will know which format to apply by knowing which format the client sent in the request, or by referring to the default format for each promptType below.
IMPORTANT NOTE: For the PIN pads that do not support formatting, triPOS will not return any errors or warnings if the client attempts to
apply a format.
The input endpoint is a part of the semi-custom screens feature of triPOS. For most devices, the input forms behave the same as the semi-custom
selection and signature forms in that they stay on the PIN pad's screen until the next request is received. This allows
the client to create a custom flow without the interruption of the PIN pad going back to 'idle' after each screen. At the end
of the flow, the client can send a call to the /api/v1/idle endpoint to return the PIN pad to the idle screen.
The only exceptions to this behavior are the CXPI devices. For these devices, the input form will disappear after input
is entered, and either a "Please wait" or blank screen will appear (dollar amount screens will go to "Please wait", others will go to blank).
The same prompt may appear differently across different PIN pads. Some PIN pads with smaller screens may abbreviate the prompt
or allow the prompt to span multiple lines. At this point, the text cannot be modified.
promptType below, its default formatType is listed in parentheses. For each formatType, the table also describes which devices support it. For example,
if a promptType's default formatType is PhoneWithAreaCodeSeparatorAndDashes, but a certain device does not support PhoneWithAreaCodeSeparatorAndDashes, that device
will display it with no format. For the CXPI devices, all promptTypes that prompt for a dollar amount will be displayed with format AmountWithDollarCommaDecimal.
| Mx915/Mx925 | iSC250/iSC480 | Link2500, Lane3000, Lane3000 Deluxe, Lane3600, Move5000, Self4000 | Lane5000, Lane7000, Lane7000 Deluxe, Lane8000, Lane8000 Deluxe | |
|---|---|---|---|---|
| promptType | ||||
tip |
Y | Y | Y | Y |
cashback |
Y | Y | Y | Y |
amount |
Y | Y | Y | Y |
zip |
Y | Y | Y | Y |
phone |
Y | Y | Y | Y |
easyPayCode |
Y | Y | Y | Y |
data |
N | N | N | N |
serverId |
N | N | N | N |
checkNumber |
N | N | N | N |
tableNumber |
N | N | N | N |
| formatType | ||||
noneDisplayed on screen: 1234 Returned by triPOS: 1234 |
Y | Y | Y | Y |
amountWithCommaDisplayed on screen: 1,234 Returned by triPOS: 1234 |
Y | Y | Y | Y |
amountWithDollarCommaDisplayed on screen:$ 1,234 Returned by triPOS: 1234 |
Y | Y | Y | Y |
amountWithDollarCommaDecimalDisplayed on screen:$ 1,234.00 Returned by triPOS: 123400 |
Y | Y | Y | Y |
phoneWithAreaCodeSeparatorAndDashesDisplayed on screen: (123) 456-7890 Returned by triPOS: 1234567890 |
Y | Y | Y | Y |
allowLeadingZeroDisplayed on screen: 0123 Returned by triPOS: 0123 |
Y | Y | Y | Y |