Restaurant API Fields
The table below displays the core API fields required for the restaurant industry, and should be used in conjunction with the appropriate TPP Interface guide.
To ensure a transaction is in balance, the Transaction Amount (API field 0002) must equal the total of the following fields:
-
Tax Amount 1 (0072)
-
Tip 1 Amount (0201)
-
Tip 2 Amount (0202)
-
Food Amount (0207)
-
Beverage Amount (0208)
| Field | Name | Length Type |
Description |
|---|---|---|---|
| 0001 | Transaction type | 2 numeric |
REQUIRED. Must be in all input requests. Ex. 0001,02 |
| 0002 | Transaction amount | 4-8 cents |
REQUIRED. Total amount for the transaction including tax and tip. Valid range is 0.00 - 9999999999.99. Ex. 0002,125.50 |
| 0003 | Account number or Token |
31-128 alphanumeric |
REQUIRED. Entered at the PIN pad device if using encryption, Simplify, or EMV. Sent from POS when using tokens. Ex. 003,xxxxxxxxxxxxxxxx OR 003,ID:xxxxxxx if using tokens. |
| 0004 | Expiration date | 4 date |
REQUIRED. Format: MMYY. Entered at the PIN pad device if using encryption, Simplify, or EMV. Sent from POS when using tokens. Ex. 0004,1225 |
| 0007 | Reference number | 1-8 numeric |
Required. Unique number (1-99999999) supplied by the POS to identify the transaction within a batch/processing period. Number should be unique within a settlement batch. Ex. 0007,87654321 |
| 0011 | User data | 80 alphanumeric |
REQUIRED. Commas, tabs and special characters are not allowed. Data is only echoed back and is not stored. If user data is needed at settlement, use Field 1105 Ex.: 0011,xxx.. |
| 0012 | Force flag | 1 numeric |
OPTIONAL. Used for Force Authorizations only. Used with host capture processors who provide duplicate checking. Will override the host checking by enabling a valid “duplicate” (defined by the host) transaction in the batch. Ex. 0012,1 |
| 0013 | Transaction date | 6 date |
OPTIONAL. Format: MMDDYY. Used to override the system date as the date to be used for the transaction. Ex. 0013,112822 |
| 0014 | Transaction time | 6 time |
OPTIONAL. Format: HHMMSS. Used to override the system time as the time to be used for the transaction. Ex. 0014,121515 |
| 0025 | Business date | 6 date |
OPTIONAL. Format: MMDDYY. Used to control the business date in Gateway. Ex. 0025,103122 |
| 0047 | POS data code | 15-29 alphanumeric |
REQUIRED. Tableized field delimited with a semicolon “;” between each POS DataCode value. Format: ;;;;;;;;;;;;;;*, Field IDX 1 POS Device Capability Indicator Field IDX 2 Cardholder Authentication capability Field IDX 3 Terminal Card Capture Capability Field IDX 4 Terminal Operating/Location Environment Field IDX 5 Cardholder Present Indicator Field IDX 6 Card Present Indicator Field IDX 7 Card Data Input Mode Indicator Field IDX 8 Card Data Authentication Mode Indicator Field IDX 9 Cardholder Authentication Mode Indicator Field IDX 10 Card Data Output Capability Indicator Field IDX 11 Terminal Data Output Capability Indicator Field IDX 12 PIN Capture Capability Indicator Field IDX 13 POS Device Attendance Indicator Field IDX 14 POS Device Terminal Type Field IDX 15 Reserved. See Segment Formatting Rules for POS Data Code Ex. 0047,C;1;1;1;0;1;6;5;4;1;3;C;0;4 |
| 0050 | CVV2/CVC2/CID Information | 3-4 numeric |
OPTIONAL. Used for keyed/manual transactions only. Entered at PIN pad if using encryption, Simplify, or EMV. Ex. 0050,123 |
| 0054 | POS entry mode | 2 numeric |
REQUIRED. ISO values: 00 Unknown 01 Manual/Key Entry 04 OCR code read 05 Integrated circuit card read - CVV data reliable (smart card) 07 Contactless M/Chip or Visa Smart Card read10-Scanned MICR/check 79 Chip Card capable - manual PAN read (used for EMV fall back to manually entered) 80 Chip Card capable - unaltered track data read (used for EMV fall back to swipe) 82 Contactless Mobile Commerce device85-Internet (not an ISO value) 86 Contactless EMV fall back to Contact EMV 90 Magnetic Stripe-CVV/CVC certified, unaltered Track Data (1 or 2) included in Authorization Request. Required to participate in PS/2000 or CPS/2000 91 Contactless magnetic stripe read95-Integrated circuit card read - CVV data unreliable Ex.: 0054,05 |
| 0060 | Unique device ID | 1-8 numeric |
REQUIRED. Merchant-assigned value to meet TPP requirements. Data must be stored and displayed, and may be used in settlement. Ex.: 0060,51563621 |
| 0070 | Customer code | 1-25 alphanumeric |
REQUIRED. Merchant-assigned code to identify a customer. Default to Field 7. Ex.: 0070,87654321 |
| 0071 | Tax 1 indicator | 1 numeric |
REQUIRED. Passing tax fields 71 & 72 protects merchants from commercial card downgrades. If 71=1, then 72 should not equal $0.00. Values are: 0=Non-Taxable 1=Yes 2=No Ex.: 0071,1 |
| 0072 | Tax amount | 1-14 cents |
REQUIRED. Sales tax. Contains the total of all tax amounts for the purchase. Valid range is 0.00 - 9,999.99 max Ex.: 0072,7.00 |
| 0109 | Terminal ID | 1-8 alphanumeric |
REQUIRED. References a terminal defined in merchant configuration that tells the Gateway which processor to dial, what phone number to use and which merchant information to access. Ex.: 0109,00000003 |
| 0110 | Cashier ID | 1-8 alphanumeric |
OPTIONAL. Can contain any code or name up to 8 uppercase characters to identify the person running the POS. Ex.: 0110,SDC88888 |
| 0115 | Transaction qualifier | 3 numeric |
OPTIONAL. Determines type of account used. Valid values: 010 Credit 020 Check Auth 025 Private Lbl 030 Debit 040 EBT 050 Stored Value 051 Loyalty 060 MVR disable user 070 MVR update password 090 HIPPA Ex.: 0115,010 |
| 0200 | Charge description | 1 numeric |
REQUIRED. Details the items purchased. Valid values: 1 = FOOD 2 = FOOD/BEV 3 = BEVERAGE Default to 1 if not provided. Ex.: 0200,2 |
| 0201 | Tip 1 amount | 4-7 cents |
OPTIONAL. Tip for primary server (may not be known at time of authorization). Ex.: 0201,2.75 |
| 0202 | Tip 2 amount | 4-7 cents |
OPTIONAL. Tip for secondary server. Ex.: 0202,1.50 |
| 0203 | Employee ID of primary server | 1-8 numeric |
OPTIONAL. Unique number which identifies the primary server. Ex.: 0203,23 |
| 0204 | Employee ID of secondary server | 1-8 numeric |
OPTIONAL. Unique number which identifies the primary server. Ex.: 0204,501 |
| 0205 | Check number (ROC) | 1-6 numeric |
OPTIONAL. Ticket number for the transaction. May be the same as Field 7. Ex.: 0205,123456 |
| 0207 | Food amount | 4-7 cents |
OPTIONAL. Dollar amount of the total ticket price for food charges. Valid range is 0.00 - 9,999.99 max. Ex.: 0207,153.78 |
| 0208 | Beverage amount | 4-7 cents |
OPTIONAL. Dollar amount of the total ticket price for beverage charges. Valid range is 0.00 - 9,999.99 max. Ex.: 0208,25.00 |
| 0209 | Table number | 1-3 numeric |
OPTIONAL. Identifies the customer’s table number. Ex.: 0209,47 |
| 0210 | Description of Tip #1 | 1-8 alphanumeric |
OPTIONAL. Description of first tip amount. This field should contain ‘TIP’ even if no Tip 1 is included. Ex.: 0210,TIP |
| 0213 | Food description | 1-24 alphanumeric |
OPTIONAL. Description of food charges. Valid values: “FOOD” for food charges only. “BEVERAGE” for drink charges only. “FOOD/BEV” for food and drink charges. Default to FOOD/BEV if not provided. Ex.: 0213,FOOD/BEV |
| 0214 | Beverage description | 1-8 alphanumeric |
OPTIONAL. Description of beverage charges. Valid values are “BEVERAGE” or “DRINKS" Ex.: 0214,BEVERAGE |
| 0215 | Description of Tip #2 | 1-8 alphanumeric |
OPTIONAL. Description of a second tip amount. This field should contain ‘TIP’ even if no Tip 2 is included. Ex.: 0215,TIP |
| 0216 | Number of guests | 2 numeric |
OPTIONAL. Number of guests on the ticket. Ex.: 0216,02 |
| 0647 | Partial authorization acceptance | 1 numeric |
OPTIONAL. 0 = POS cannot support partial authorization responses. 1 = POS can support partial authorization responses Ex.: 0647,1 |
| 0700 | Billing zip code | 5-9 numeric |
OPTIONAL. Card holder's zip code. Used for keyed or manual transactions only. Entered at the PIN pad if using encryption, Simplify, or EMV. Ex.: 0700,30076 |
| 0701 | Billing street address | 1-20 alphanumeric |
Card holder's street address. Used for keyed or manual transactions only. OPTIONAL for Visa and MasterCard. REQUIRED for American Express and Discover. Ex.: 221B Baker Street |
| 1008 | Masked account number | ID alphanumeric |
OPTIONAL. Used if tokens are part of the project scope. 'ID:' returns a masked credit card number. Ex.: 1008,ID: |
| 1378 | EMV Approved Receipt Field List | 1-256 alphanumeric special |
OPTIONAL. EMV-specific delimited field that contains the API fields required by the merchant’s TPP to be printed. See our Receipts page for examples. |
| 1379 | EMV Declined Receipt Field List | 1-256 alphanumeric special |
OPTIONAL. EMV-specific delimited field which contains the API fields required by the merchant’s TPP to be printed. See our Receipts page for examples. |
| 1380 | POS Entry Indicator | 1-20 alphanumeric |
OPTIONAL. TPP-specific POS entry mode text for receipts based on the value in field 0054 and TPP rules. Fusebox TPP Interface layer sets this response field. |
| 8002 | Location name | 1-16 alphanumeric |
OPTIONAL. The unique location name. Ex.: 8002,ATL26 |
| 8006 | Chain code | 1-6 alphanumeric |
OPTIONAL. Used for key management in Gateway environments. The code is assigned during the boarding/conversion process. Ex.: 8006,TST123 |