Get Check Info Request and Response (Tran Type 39-02)
The Get Check Information Request is used to request open check data from the POS. This request is sent after the server enters a check and/or table number (see below for details).
The Get Check Information Response returns a list of open checks. Open checks can be presented as check numbers or as text descriptions; this is controlled by the applicable Check Information field (API 5114 to 5212).
The check data returned in the Get Check Information Response can alternatively be returned in the Login Response. In this case, the Get Check Information Message will not be used and the Login Response will be followed by the processing described below under Get Check Information Response.
Request Flow
Controlling Returned Check Data
The scope of the Get Check Info Request is determined by server response to Simplify prompting. Simplify prompting is controlled by the value returned in field 5103 of the Login Response. The following scenarios are supported:
Login Response API 5103 | Simplify prompts | Server enters | Get Check Info Request API 5105 | Get Check Info Request API 5106 | Scope of Request |
---|---|---|---|---|---|
00 | Table # and (optional) Check # | Table # | Table # | (not present) | All checks for table |
00 | Table # and (optional) Check # | Table # and Check # | Table # | Check # | Specified check |
01 | Check # | Check # | (not present) | Check # | Specified check |
Note: The list of returned checks has a Back button that will return to the prompt for Table and/or Check Number. (Cancel key on this screen has the same effect.) The server can then request information for a different check(s). A new Get Check Information Message exchange will take place, and a new list of checks displayed.
Response Flow
The Get Check Information Response (or the Login Response) contains data for one or more checks.
- If data is returned for only one check, Simplify will automatically begin processing the check (as described under Make Payment Request).
- If data is returned for more than one check, Simplify will display a list of checks and the server will select a check for processing. The data displayed for each check will be based on whether the corresponding Check Information field contains valid Text Data (fifth subfield; see Check Information Format below):
- 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 semi-colons):
|
Sample Messages
Request
API Field #, Value | Description |
---|---|
0001,39 | Transaction Type |
5100,02 | Message Type |
5106,125 and/or 5105,4 | Check Number and/or Table Number See next table for details. |
5218,714 | Pay@Table Message Reference Number |
5219,12345678 | Pay@Table Session ID |
Response
Check data sent in the following messages will be displayed (with headings, if applicable) as the strings shown below following each message.
No Text Data
Note: This sample includes field 5104 Tip Settings (optional). If not sent, settings sent in the Login Response will be used (if not sent in either message, default settings will be used).
API Field #, Value | Description |
---|---|
0001,39 | Transaction Type |
5100,02 | Message Type |
5104, [see value below] | Tip Settings. See Field Formats and Descriptions under Field 5104 for details. |
5110,00 | POS Response Code |
5111,Approved | POS Response Message |
5114,[see value below] | Check Information 1 |
5115,[see value below] | Check Information 2 |
5116,[see value below] | Check Information 3 |
5218,714 | Pay@Table Message Reference Number |
5219,12345678 | Pay@Table Session ID |
5104,15;18;20FS1FSPlease Enter Additional\n Gratuity (FS = 1 byte field separator)
5114,25; $1.00;22;LCOLE;
5115,26; $2.00;22;JOANNE;
5116,1112;$3.00;12;JEREMY;
“25 $1.00 22 LCOLE”
“26 $2.00 22 JOANNE”
“1112 $3.00 12 JEREMY”
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, [see value below] | Check Information 1 |
5115, [see value below] | Check Information 2 |
5116, [see value below] | Check Information 3 |
5218,714 | Pay@Table Message Reference Number |
5219,12345678 | Pay@Table Session ID |
5114,25; $1.00;22;LCOLE;#25 $1.00 Seat 25;
5115,26; $2.00;22;JOANNE;#26 $2.00 Man with cigar;
5116,112;$3.00;12;JEREMY;#112 $3.00 Green jacket;
“#25 $1.00 Seat 25”
“#26 $2.00 Man with cigar“
“#112 $3.00 Green jacket“
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,[see value below] | Check Information 1 |
5115,[see value below] | Check Information 2 |
5116,[see value below] | Check Information 3 |
5218,714 | Pay@Table Message Reference Number |
5219,12345678 | Pay@Table Session ID |
5114,25; $1.00;22;LCOLE;Guest in Seat 25;
5115,26; $2.00;22;JOANNE;Man with cigar;
5116,112;$3.00;12;JEREMY;Guest in green jacket;
“Guest in Seat 25”
“Man with cigar”
“Guest in green jacket”