Field 11 (User Data)

Field 11 is defined by the Gateway Interface Specification as a user-defined field with a variable length (up to a maximum of 512 characters).

Structure of Field

For added flexibility, this field contains two data areas, a Command Area for non-tokenized data and a Token Area for tokenized data (“TAG Length Data Structure”). These data areas are used as follows (see below for details):

  • The Command Area contains subfields required in the request. Some or all of these subfields may be echoed in the response. In Non-Financial Messages, the Command Area in the response may contain a Completion Code indicating the outcome of the request.

  • The Token Area is informational. It can be used to inform the POS of error conditions and/or Simplify version data.

    • Exception: In the Quick Chip (36-40) Message, data is required in both the Command and Token areas of the request.

The generic format of field 11 is as follows:

Subfield NameDescriptionOffsetLength
Command AreaThe format of fields in the Command Area depends on the Transaction Type (and Message Type for Transaction Type = 36). The Maximum Length of this area is currently 11 characters.0VAR
Field SeparatorThe character ‘?’ is used to separate the Command Area from the Token AreaVAR1
Token AreaThe Token Area contains Tokenized fields in the format “TLLDDD…” where:
  • T = Token
  • LL = Length of Data
  • DDD… = Data (Length = LL)
VARVAR

The Command Area will be discussed below, followed by the Token Area

Command Area

As shown in the following tables, the use of the Command Area can vary by Tran Type and (for Non-Financial Messages) by Message Type. Since the use of this field for Financial Messages is totally distinct from that for Non-Financial Messages, the following discussion will be broken down by these two categories.

Command Area - Financial Messages

Depending on Tran Type, the following subfields may be used in the Command Area of field 11 for Financial Messages.

BytesSubfield NameUse
1-3Switch Timeout ValueDefines host timeout value used by Simplify
4Offline ResponseSet to “Y” on Inquiry Request to ensure correct offline processing.
4-5Auto Signature ControlCan be used to ovrride configured Auto Sigature settings

The following table shows supported Command Area subfields for each defined Financial Message Type:

Tran
Type
Message NameBytes 1-3Bytes 4-5
01Auth Only MessageSwitch Timeout Value
(all financial messages)
Auto Signature Control
02Sale MessageAuto Signature Control
07Prior Auth Sale Message
09Return MessageAuto Signature Control
13Batch Close Message
14Batch Inquiry Message
22Inquiry MessageOffline Response
(byte 4 only)
24Balance Inquiry Message
37Token Request Message
61Full Auth Reversal Message
75Incremental Auth Message
76Auth Reversal Message

Command Area subfields (Financial Messages)

Field 11 Command Area subfields are used in Financial messages as follows:

  • Switch Timeout Value – Three-digit field (right-justified / zero-filled) controls how long (in seconds) Simplify will wait for a response from Fusebox.

    note

    The length of this timeout value must be shorter than the POS timeout value.

  • Auto Signature Control – Two-byte field that can be used to override auto signature configuration on a per transaction basis. The use of this field is optional and must be enabled under configuration. Use as follows:

    • Send S0 to suppress auto signature for the transaction regardless of configuration settings. (No signature processing will occur unless a Signature Request is received.)

    • Send S1 to force auto signature for the transaction regardless of configuration settings.

    • If blank, configured settings will determine whether auto signature processing occurs.
      For additional information on auto signature, see Auto Signature.

  • Offline Response – Set to “Y” to ensure that an offline Inquiry Response is sent to POS when an Inquiry Request does not receive a response from the host.

Command Area - Non-Financial Messages

The purpose of a Non-Financial Message (Tran Type 36) is defined by its Message Type (field 11 bytes 1-2). The structure of the Command Area for field 11 on a Non-Financial Message can vary depending on the Message Type (bytes 1-2), but the following subfields are typical:

BytesSubfield NameUse
1-2Message TypeDefines purpose of message.
3-5Transaction Sequence NumberPOS transaction sequence number.
6-8Screen IDUsed in request to define PIN Pad screen to be displayed (may be blank or not used).
9-11Completion CodeUsed in response to inform POS of request outcome.

Variations from the above structure are illustrated in the following table showing supported Command Area subfields for each defined Message Type. Except where indicated, the Command Area in the response echoes the request. ** means see note below.

Tran
Type
Message
Name
bytes 1-2
(Message
Type)
bytes 3-5bytes 6-8bytes 9-11
36 (all
messages)
Signature Request01Transaction
Sequence #
(all messages)
Screen ID
Signature Response02Screen IDCompletion Code
Version Number Inquiry
Request/Response **
06
Initiate HEM/IngEstate
Request/Response
07
Scrolling Receipt
Request
10
Scrolling Receipt Stop11
Exit Reversal Mode12
SAF Done
Request/Response
13
Informational Prompt
Request/Response **
14Screen ID
(not used)
Timeout/
Completion Code
System Command
Request/Response
15Command
Quick Chip
Request/Response **
40Completion Code
(only in response)
Print Request Message
Request/Response **
45
Status Inquiry51Status Identifier

Note concerning the following Non-Financial Message Types:

  • Message Type 06 (Version Number Inquiry) – Transaction Sequence Number is followed in the response by variable-length Version and Build Information (preceded by a “?”).

  • Message Type 14 (Informational Prompting) – Completion Code (response) is followed by variable-length Version and Build Information (preceded by a “?”). For Tag 013, the Timeout field (in the request) is not used.

  • Message Type 40 (Quick Chip Message) – Data is also required in the Token Area (Q token).

  • Message Type 45 (Print Request Message) – Transaction Sequence Number not sent.

  • Message Types 08, 09, 13, 16-21 – These values are reserved for future use.

Command Area subfields (Non-Financial Messages)

Field 11 Command Area subfields are used in Non-Financial messages as follows:

  • Message Type – Two-digit field used along with the Tran Type to identify the purpose of the message. Always present for Tran Type = 36.

  • Transaction Sequence Number – Three-byte field containing POS transaction sequence number. This field is echoed back in the response. Always present for Tran Type = 36.

  • Screen ID – Three-digit field in Signature Request used to indicate which screen should be displayed when prompting for the customer’s signature. This field is echoed back in Signature Response. (Currently supported values are 001 and 002.) This field is also present in the Informational Prompt request and response messages, but is not used.

  • Completion Code – Three-digit field in Signature, Informational Prompt or Quick Chip response indicating the outcome of the request. The following Completion Codes are currently defined:

Completion CodeOutcome
000Successful
004DONE/ACCEPT key pressed with Signature data present
006ABORT/CANCEL key pressed twice with no detectable signature
008Signature entry aborted by Simplify
009Signature entry aborted due to memory being exceeded
010Memory exhaustion
099Customer pressed CANCEL after starting to sign. (NA 006 will be sent if cannot detect signature)
100
  • Transaction not allowed for device.
  • PIN Pad is currently busy.
  • For signature capture: Unable to create sigcap object or signature too small two times.
  • In Quick Chip response: error (e.g. Quick Chip not enabled).
131In Quick Chip response: Customer pressed Cancel.
132In Quick Chip response: Bad Card Type
133In Quick Chip response: Transaction not allowed.
200EMV card still inserted
998Invalid format
999Timed out
  • Version Build Info – Simplify version and build information.

  • Timeout – Screen timeout in seconds. (000=No timeout)

  • Command – System command from POS to Simplify. The following commands are currently supported:

CommandRequested Action
001PIN Pad reboot
  • Status Identifier – Three-digit transaction status code sent from Simplify to POS in Status Messages. A table included in a Simplify parameter file indicates which Status Identifiers are enabled. The following Status Identifiers are currently defined:
Status IdentifierStatus Message
001Processing Please Wait
002Slide Card
003Enter PIN
004Amount OK
005Enter Tender Type (Debit / Credit)
006Cash Back
007Enter Account Number
008Enter Expiration Date
009Enter CVV
010Enter ZIP Code (AVS Data)
011Cash Back Other
012 – 016[Reserved]
017EMV AID list
018Language Selection
019EMV Account Type Selection
020Enter Tip
021EMV card has been removed
022Swiped not allowed, must use chip
023EMV fallback
024Waiting for Mifare Tap

Sample Field 11

The following sample of field 11 is for a Signature Response message sent in response to a Signature Request:

  • 0011,02555001004

This value is broken down as follows:

BytesSubfield ValueUse
1-202Message Type 02 – Signature Response
3-5555POS Transaction sequence number.
6-8001Screen ID (Echoed from Signature Request message)
9-11004Completion Code. 004 = DONE/ACCEPT key pressed with signature data present.

Token Area

Defined Tokens for the Token Area are as follows:

Token
(Case Sensitive)
DescriptionUsageMax
Length
VSimplify VersionSimplify response to POS10
SIdentifies the Source Routine of the ErrorSimplify error response to POS40
RReturn code from Source RoutingSimplify error response to POS20
EActual Error if different from ‘R’Simplify error response to POS20
QTransaction Type and Tender Type
(data is optional)
POS Quick Chip request to Simplify, echoed in response20

With the exception of the Q token, the above tokens are for informational purposes only.

Q token

The Q token must be present in order for Simplify to approve a Quick Chip (36-40) request. The format of the Q token is as follows:

QaabbFScccFS, where:

  • Q = Quick chip token

  • aa = Length of the following data (including field separators)

  • bb = Optional Transaction type (01=Auth, 02=Sale, 09=Refund)

  • FS = Field separator (1 byte)

  • ccc = Optional Tender type (e.g. 010=Credit, 030=Debit)

  • FS = Field separator (1 byte)

A sample Quick Chip request, showing the Command Area, ‘?’ separator and Token Area for field 11 is as follows:

API Field #, ValueDescription
0001,36Transaction Type
0011,40001000000?Q0402FSFSUser Data

This request is for a Sale (=02) transaction. (Tender Type not specified.)