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)

0001 (Transaction Type)

  • Description: Required in all requests. Determines what action Gateway products will perform with the data in the API input file. Store.
  • Length: 2
  • Data Type: numeric

0002 (Transaction Amount)

  • Description: Total amount of the transaction including tax, gratuity, etc. Store.
  • Valid range: 0.00 - 9999999999.99 ($9,999,999,999.99 Max)
  • Length: 4 - 13
  • Data Type: cents

0003 (Account number or Token)

  • Description: 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.
  • Length: 31 - 128
  • Type: alphanumeric

0004 (Expiration Date)

  • Description: REQUIRED. Format: MMYY. Entered at the PIN pad device if using encryption, Simplify, or EMV. Sent from POS when using tokens.
    Ex. 0004,1225
  • Length: 4
  • Data Type: date

0007 (Reference number)

  • Description: 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
  • Length: 1 - 8
  • Data Type: numeric

0011 (User Data)

  • Description: 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..
  • Length: 80
  • Data Type: alphanumeric

0012 (Force Flag)

  • Description: 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
  • Length: 1
  • Type: numeric

0013 (Transaction Date)

  • Description: OPTIONAL. Format: MMDDYY. Used to override the system date as the date to be used for the transaction. Ex. 0013,112822
  • Length: 6
  • Data Type: date

0014 (Transaction time)

  • Description: OPTIONAL. Format: HHMMSS. Used to override the system time as the time to be used for the transaction. Ex. 0014,121515
  • Length: 6
  • Data Type: time

0025 (Business date)

  • Description: OPTIONAL. Format: MMDDYY. Used to control the business date in Gateway. Ex. 0025,103122
  • Length: 6
  • Data Type: date

0047 (POS data code)

  • Description: REQUIRED. Tableized field delimited with a semicolon “;” between each POS Data Code value. Format: ;;;;;;;;;;;;;;*,
  • Valid Values:
    • 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
  • Length: 15 - 29
  • Data Type: alphanumeric

0050 (CVV2/CVC2/CID Information)

  • Description:
    • OPTIONAL. Used for keyed/manual transactions only.
    • Entered at PIN pad if using encryption, Simplify, or EMV. Ex. 0050,123
  • Length: 3 - 4
  • Data Type: numeric

0054 (POS entry mode)

  • Description: 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 device
    • 85 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 values
    • 91 Contactless magnetic stripe read
    • 95 Integrated circuit card read - CVV data unreliable
      Ex.: 0054,05
  • Length: 2
  • Data Type: numeric

0060 (Unique Device ID)

  • Description: REQUIRED. Merchant-assigned value to meet TPP requirements. Data must be stored and displayed, and may be used in settlement. Ex.: 0060,51563621
  • Length: 1 - 8
  • Data Type: numeric

0070 (Customer Code)

  • Description: REQUIRED. Merchant-assigned code to identify a customer.
  • Valid Value: Default to Field 7. Ex.: 0070,87654321
  • Length: 1 - 25
  • Data Type: alphanumeric

0071 (Tax 1 indicator)

  • Description: REQUIRED.
    • Passing tax fields 71 & 72 protects merchants from commercial card downgrades.
    • If 71=1, then 72 should not equal $0.00. Valid Values:
    • 0 = Non-Taxable
    • 1 = Yes
    • 2 = No Ex.: 0071,1
  • Length: 1
  • Data Type: numeric

0072 (Tax amount)

  • Description: 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
  • Length: 1 - 14
  • Data Type: cents

0109 (Terminal ID)

  • Description: 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
  • Length: 1 - 8
  • Data Type: alphanumeric

0110 (Cashier ID)

  • Description: OPTIONAL. Can contain any code or name up to 8 uppercase characters to identify the person running the POS. Ex.: 0110,SDC88888
  • Length: 1 - 8
  • Data Type: alphanumeric

0115 (Transaction qualifier)

  • Description: 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
  • Length: 3
  • Data Type: numeric

0200 (Charge description)

  • Description: REQUIRED. Details the items purchased.
  • Valid values:
    • 1 = FOOD
    • 2 = FOOD/BEV
    • 3 = BEVERAGE Default to 1 if not provided. Ex.: 0200,2
  • Length: 1
  • Data Type: numeric

0201 (Tip 1 amount)

  • Description: OPTIONAL. Tip for primary server (may not be known at time of authorization). Ex.: 0201,2.75
  • Length: 4 - 7
  • Data Type: cents

0202 (Tip 2 amount)

  • Description: OPTIONAL. Tip for secondary server. Ex.: 0202,1.50
  • Length: 4 - 7
  • Data Type: cents

0203 (Employee ID of primary server)

  • Description: OPTIONAL. Unique number which identifies the primary server. Ex.: 0203,23
  • Length: 1 - 8
  • Data Type: numeric

0204 (Employee ID of primary server)

  • Description: OPTIONAL. Unique number which identifies the primary server. Ex.: 0204,501
  • Length: 1 - 8
  • Data Type: numeric

0205 (Check Number ROC)

  • Description: OPTIONAL. Ticket number for the transaction. May be the same as Field 7. Ex.: 0205,123456
  • Length: 1 - 6
  • Data Type: numeric

0207 (Food Amount)

  • Description: OPTIONAL. Dollar amount of the total ticket price for food charges.
  • Valid range is 0.00 - 9,999.99 max. Ex.: 0207,153.786
  • Length: 4 - 7
  • Type: cents

0208 (Beverage amount)

  • Description: OPTIONAL. Dollar amount of the total ticket price for beverage charges.
  • Valid range is 0.00 - 9,999.99 max. Ex.: 0208,25.00
  • Length: 4 - 7
  • Data Type: cents

0209 (Table Number)

  • Description: OPTIONAL. Identifies the customer’s table number. Ex.: 0209,47
  • Length: 1 - 3
  • Type: numeric

0210 (Description of Tip #1)

  • Description: OPTIONAL. Description of first tip amount. This field should contain ‘TIP’ even if no Tip 1 is included. Ex.: 0210,TIP
  • Length: 1 - 8
  • Data Type: alphanumeric

0213 (Food Description)

  • Description: 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
  • Length: 1 - 24
  • Data Type: alphanumeric

0214 (Beverage description)

  • Description: OPTIONAL. Description of beverage charges.
  • Valid values are “BEVERAGE” or “DRINKS”. Ex.: 0214,BEVERAGE
  • Length: 1 - 8
  • Data Type: alphanumeric

0215 (Description of Tip #2)

  • Description: OPTIONAL. Description of a second tip amount. This field should contain ‘TIP’ even if no Tip 2 is included. Ex.: 0215,TIP
  • Length: 1 - 8
  • Data Type: alphanumeric

0215 (Number of guests)

  • Description: OPTIONAL. Number of guests on the ticket. Ex.: 0216,02
  • Length: 2
  • Data Type: numeric

0647 (Partial authorization acceptance)

  • Description: OPTIONAL.
  • Valid Values:
    • 0 = POS cannot support partial authorization responses.
    • 1 = POS can support partial authorization responses. Ex.: 0647,1
  • Length: 1
  • Data Type: numeric

0700 (Billing Zip Code)

  • Description: 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
  • Length: 5 - 9
  • Data Type: numeric

0701 (Billing Street Address)

  • Description: Card holder’s street address.
  • Valid Values:
    • Used for keyed or manual transactions only.
    • OPTIONAL for Visa and MasterCard.
    • REQUIRED for American Express and Discover. Ex.: 221B Baker Street
  • Length: 1 - 20
  • Type: alphanumeric

1008 (Masked Account Number)

  • Description: OPTIONAL. Used if tokens are part of the project scope.
  • ‘ID:’ returns a masked credit card number. Ex.: 1008,ID:
  • Data Length: ID
  • Data Type: alphanumeric

1378 (EMV Approved Receipt Field List)

  • Description: 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.
  • Length: 1 - 256
  • Data Type: alphanumeric special

1379 (EMV Declined Receipt Field List)

  • Description: 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.
  • Length: 1 - 256
  • Data Type: alphanumeric special

1380 (POS Entry Indicator)

  • Description: 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.
  • Length: 1 - 20
  • Data Type: alphanumeric

8002 (Location Name)

  • Description: OPTIONAL. The unique location name. Ex.: 8002,ATL26
  • Length: 1 - 16
  • Data Type: alphanumeric

8006 (Chain Code)

  • Description: OPTIONAL. Used for key management in Gateway environments.
  • The code is assigned during the boarding/conversion process. Ex.: 8006,TST123
  • Length: 1 - 6
  • Data Type: alphanumeric