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:

  • 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. (See under Command Area-Financial Messages for details.)

  • 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:

Field NameDescriptionOffsetLength
Command Area

The format of fields in the Command Area depends on the Transaction Type

(and Message Type for Transaction Type = 36).

See under Command Area for details.

0VAR
Field SeparatorThe character ’?’ is used to separate the Command Area from the Token AreaVAR1
Token Area

The Token Area contains Tokenized fields in the format “TLLDDD…” where

T = token

LL = Length of Data

DDD… = Data (Length = LL)

VARVAR

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

The following subfield is used in the Command Area of field 11 for Financial Messages.

BytesSubfield NameUse
1-3Switch Timeout ValueDefines host timeout value used by Simplify.

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.

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 ID

Used 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 (see next page) showing supported Command Area subfields for each defined Message Type. Except where indicated, the Command Area in the response echoes the request.

Tran
Type
Message
Name
Message
Type
bytes 1-2


bytes 3-5


bytes 6-8


bytes 9-11
36 (all
messages)
Signature Request01Transaction
Sequence #
(all messages
except as noted)
Screen ID
Signature Response02Screen IDCompletion Code
Version Number Inquiry
Request/Response **
06
Load Simplify File
via Secure File Transfer
Request/Response
07
ELM Encryption
Advance DDK
Request/Response
08Timeout Value for
Advance DDK
message to host
ELM Diagnostic
Request/Response
09
Scrolling Receipt
Request
10
Scrolling Receipt Stop11
(Reserved for Bridge) **13
Informational Prompt
Request/Response
14Screen ID
(not used)
Timeout/
Completion Code
System Command
Request/Response
(future use)
15Command
Quick Chip
Request/Response **
40Completion Code
(only in response)
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 13 (SAF Done Message) – Reserved for Bridge. Not used by POS.

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

  • The values 13, 16-21 for Message Type are reserved.

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. (Designed for future use. Currently only ID = 001 is in use.) This field is also present in the Informational Prompt Request/Response, but is not used.

  • Completion Code – Three-digit field in Signature Response or Informational Prompt Response indicating the outcome of the request.

    Completion CodeOutcome
    000In Informational Prompt and Quick Chip responses: Successful
    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)
    100Transaction 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 Information – Simplify version and build information.

  • Timeout Value for advance DDK message to host – How long Simplify will wait for a host response to an advance DDK request.

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

  • Command – System command from POS to Simplify. Currently supported command:

    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 enabled:

    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
    019EMV Account Type Selection
    021EMV card has been removed
    022Swiped not allowed, must use chip
    023EMV fallback

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 valueSubfield description
0-102Message Type (02 = Signature Response)
3-5555Transaction sequence number (echoed from Signature Request message)
6-8001Screen ID (echoed from Signature Request message)
9-11004Completion Code (004 = DONE/ACCEPT key pressed w/ 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
Q

Transaction 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

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

FS = Field separator

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

0001,36

0011,40001000000?Q0402FSFS

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