Tag 031 - Tactile Keypad
Simplify supports a Tactile Keypad message on all Tetra devices. This message displays up to three lines of text and an input field showing formatted user input. Allowed input consists of numbers keyed on the device keypad.
A Mask subfield in API 5001 in the request defines how the input field is initialized, the maximum number of digits allowed in user input, and how the input will be formatted. A Direction subfield can be used to determine the direction in which the input field is filled. API 5001 must be terminated with a field separator. See under Request for more information.
If the customer presses the Enter key, the user input is returned in the response, formatted as defined by the Mask (except no Input Mode masking).
API 5001 Format
Request
| Subfield Name | Length | Description |
|---|---|---|
| TTT | 3 | Tag (always = 031) |
| LLL | 3 | Length of the following data |
| Title1 | Var. | Title 1 |
| FS | 1 | Field separator (Hex 1C) |
| Title2 | Var. | Title 2 |
| FS | 1 | Field separator (Hex 1C) |
| Title3 | Var. | Title 3 |
| FS | 1 | Field separator (Hex 1C) |
| Mode | 1 | Input Mode (Password Flag):
|
| FS | 1 | Field separator (Hex 1C) |
| Mask | Var. | Defines data types allowed as input and how input will be formatted. See further below. |
| FS | 1 | Field separator (Hex 1C) |
| UserChar | Var. | Blank (not supported) |
| FS | 1 | Field separator (Hex 1C) |
| Direction | 1 | Direction in which the input field is filled (see further below):
|
| FS | 1 | Field separator (Hex 1C) |
Mask
The Mask functionality supported for this message is a subset of that supported for the Virtual Keyboard message (see under Tag 030 for detailed description). It can contain format constants (’$’, ‘(’, ‘)’, ‘-’, etc.) and format characters. The only format characters supported are /d and /D:
- /d accepts a numeric character (decimal). Initialized as a blank space.
- /D accepts a numeric character (decimal). Initialized as 0.
Example: The initial display for Mask = $/d/d/d/D./D/D is $ 0.00
Direction
A value of 1 (left to right) is only valid if Mask is defined. If Direction is blank, invalid, or not present, a default of 0 (right to left) is used.
Example: If Mask = $/d/d/d/D./D/D and Direction = 0, and user enters 5000, the formatted input will be $ 50.00.
important
If Direction = 1 and user enters 5000, formatted input for the above Mask will be $5000.
Response
| Subfield Name | Length | Description |
|---|---|---|
| TTT | 3 | Tag (always = 031) |
| LLL | 3 | Length of the following data |
| ActionButton | Var. | If API 0011 Completion Code = 000 (success), returns code for key pressed:
|
| FS | 1 | Field separator (Hex 1C) |
| Data | Var. | If ActionButton =777 (Enter), returns formatted input text (if any). |
Sample Message
Request
The following request tells Simplify to display the following screen. As user input is entered, it is formatted onscreen as defined by the Mask (or by Input Mode, if used).
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See API 0011 (User Data). |
| 5001,[see value below] | Non-Financial Data
|
5001,031033Donate TodayFSFSFS0FS$/d/d/d/D./D/DFSFS0FS
Response
| API Field #, Value | Description |
|---|---|
| 0001,36 | Transaction Type |
| 0011,xxx.. | User Data. See API 0011 (User Data). |
| 5001,031012777FS$ 5.00 | Non-Financial Data
|
| 5002,12189383 | Device serial number (if present) |
Additional Request Sample (API 5001)
| Value in API 5001 | Screen Use |
|---|---|
| 031064Sign Up For RewardsFSEnter MobileFSFS0FS(/d/d/d) /d/d/d - /d/d/d/dFSFS1FS | Prompt for phone number. |