Field Formats and Descriptions
The following table gives formats/descriptions for all fields included in Simplify Pay@Table messages.
Data Type = C refers to currency fields. These fields must include an explicit decimal point.
|Field#||Field Name||Size||Data Type||Description|
|0001||Transaction Type||2||N||Simplify Tran Type.|
Always 39 for Pay@Table messages.
|0002||Transaction Amount||1-14||C||Total transaction amount (includes Tip if any).|
|0201||Tip Amount||1-14||C||Entered or selected by customer.|
Note that the POS must send this value separately in field 201 of the financial request.
|5002||Device Serial Number||1-20||A/N||PIN Pad serial number|
02=Get Check Info
|5101||Store ID||1-25||A/N||Optional field; may be blank or missing|
Only populated if a Store ID is defined under Simplify configuration.
|5102||Employee ID||1-20||A/N||Server ID|
|5103||Service Type||1||N||Controls Simplify prompt displayed on the Get Check Information screen:|
00=Table and Check Number
|5104||Tip Settings||3-101||A/N||Can be sent in Login Response and/or Get Check Information Response. Login settings apply until the next login unless different settings are defined for a check in a Get Check Information Response. (If not sent in either message, defaults are used.)|
Can contain Tip percentages, flag and text.
Format is a;b;cFSdFSe (FS = 1 byte field separator) where:
a, b, c – Tip percentages. (1 or 2 digits supported. Percentage sign is assumed.)
d – Tip flag. (Accepted in code, but not currently used. For Pay@Table, the flag in 5214 is used.)
e – Tip prompting text. (Up to 90 bytes. Can include \n to start a new line of text.)
All data is optional. Both semi-colons (;) are required, even if less than three percentages are present. First FS is required if flag is present; both are required if text is present. Code will accept FS as shown above even if d and/or e are null.
|5105||Table Number||1-25||A/N||Entered at prompt|
|5106||Check Number||1-20||A/N||Entered at prompt or selected from list|
|5107||Merchant Receipt||1-2047||A/N||Data for merchant receipt.|
Receipt lines are separated by the pound sign (#). E.g. ## tells Simplify to print a blank line before beginning the next line. Text between any two # signs must be no more than 58 bytes.
Receipt lines are printed using left justification. For center justification, pad with spaces.
|5108||Customer Receipt||1-2047||A/N||Data for customer receipt. Same format as 5107.|
|5110||POS Response Code||2||N||Response Code from POS:|
Any other value=declined/error.
|5111||POS Response Message||1-50||A/N||Response Message from POS.|
Displayed on PIN Pad.
|5114||Check Information||1-2047||A/N||Can be sent in Login Response.|
Can be sent in Get Check Info Response.
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 maximun)
- Employee ID (10 bytes maximum)
- Text data (30 bytes maximum)
See under Get Check Information Message for more information.
|…||Check Information||1-2047||A/N||Information for each check is sent in a separate field. Up to 99 checks can be processed per table, using fields 5114 through 5212.|
|5213||Partial Payment Flag||1||N||0=Disabled; 1=Enabled|
|5214||Tip Flag||1||N||Can be sent in Login Response and/or Get Check Info Response. Same transaction scope as 5104.|
1=Tip Enabled. Prompt for Tip percentage (if percentages defined, else same as 2).
2=Tip Enabled. Prompt for Tip amount (text from field 5104 if sent; else default).
3=Tip Enabled. No prompting. Automatic gratuity (text from field 5104 if sent; else default).
|5217||Type of Transaction||2||N||Simplify Tran Type sent by the POS. Supported Tran Types are:|
09=Return (should be sent if the check is a refund)
|1-8||N||Message number incremented for each Pay@Table request (from Simplify or POS) and returned in each response message (if any). Used to match requests and responses.|
For Print Receipt messages, the Reference Number must match field 0007 in the preceding financial response.
|5219||Pay@Table Session ID||1-50||A/N||Used if necessary to recover the correct session. Sent in Login Response and all subsequent messages until logout/disconnect. Incremented for each Login Response.|