Get Check Info Request and Response (Tran Type 39-02)
The Get Check Information Request is used to request check data from the POS. Depending on configuration, Simplify can request check information by table number, check number or group number.
The Get Check Information Response returns a list of open checks. Open checks can be presented as check numbers or as text descriptions controlled by the POS.
Get Check Information Request
A sample Get Check Info Request message is as follows:
| API Field #, Value | Description |
|---|---|
| 0001,39 | Transaction Type |
| 5100,02 | Message Type |
| 5106,1 and/or 5105,1 and/or 5216,1 |
Check Number and/or Table Number and/or Group Number Note: See next table for details. |
| 5218,714 | Pay@Table Message Reference Number |
| 5219,12345678 | Pay@Table Session ID |
Controlling Returned Check Data
The following fields in the Get Check Info Request can be used to control the check(s) for which data will be returned. The field(s) used for a transaction will depend on values returned in the Login Response (which control Simplify prompting) and on server input, as follows:
| API Field # | Contents | Use |
|---|---|---|
| 5105 | Table Number | Used in request if prompted for and entered. Defines a single table for which check data will be requested. |
| 5106 | Check Number | Used in request if prompted for and entered. Requests data for a single check. |
| 5216 | Group Number | This field is available for implementations that choose to use it. |
Get Check Information Response
The Get Check Information Response contains check data for Simplify to display. As illustrated by the following samples, Simplify handling of data for a check is based on whether the corresponding Check Information field contains valid Text Data (fifth subfield):
- If yes, the Text Data will be displayed and other subfields will be ignored.
- If no, the values in the other subfields will be displayed.
Check Information format
| Field # | Field Name | Size | Data Type | Description |
|---|---|---|---|---|
| 5114 . . . 5212 |
Check Information (can be repeated up to 99 times) |
1-2047 | A/N | Check Information sent in five subfields (separated by semicolons): - Check number. (25 bytes maximum) - Amount due (includes explicit decimal point; if negative, the check is a refund) (14 bytes maximum) - Check receipt (5 bytes maximum) - Employee ID (10 bytes maximum) - Text data (30 bytes maximum) |
Sample Response Messages and Screens
No Text Data
| API Field #, Value | Description |
|---|---|
| 0001,39 | Transaction Type |
| 5100,02 | Message Type |
| 5110,00 | POS Response Code |
| 5111,Approved | POS Response Message |
| 5114,25; $1.00;22;LCOLE; | Check Information 1 |
| 5115,26; $2.00;22;JOANNE; | Check Information 2 |
| 5116,1112;$3.00;12;JEREMY; | Check Information 3 |
| 5218,714 | Pay@Table Message Reference Number |
| 5219,12345678 | Pay@Table Session ID |
Text Data (Check Number, Amount Due, Check Description)
| API Field #, Value | Description |
|---|---|
| 0001,39 | Transaction Type |
| 5100,02 | Message Type |
| 5110,00 | POS Response Code |
| 5111,Approved | POS Response Message |
| 5114,25; $1.00;22;LCOLE;#25 $1.00 Seat 25; | Check Information 1 |
| 5115,26; $2.00;22;JOANNE;#26 $2.00 Man with cigar; | Check Information 2 |
| 5116,112;$3.00;12;JEREMY;#112 $3.00 Green jacket; | Check Information 3 |
| 5218,714 | Pay@Table Message Reference Number |
| 5219,12345678 | Pay@Table Session ID |
Text Data (Check Description only)
| API Field #, Value | Description |
|---|---|
| 0001,39 | Transaction Type |
| 5100,02 | Message Type |
| 5110,00 | POS Response Code |
| 5111,Approved | POS Response Message |
| 5114,25; $1.00;22;LCOLE;Guest in Seat 25; | Check Information 1 |
| 5115,26; $2.00;22;JOANNE;Man with cigar; | Check Information 2 |
| 5116,112;$3.00;12;JEREMY;Guest in green jacket; | Check Information 3 |
| 5218,714 | Pay@Table Message Reference Number |
| 5219,12345678 | Pay@Table Session ID |
