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:
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.
|Field Separator||The character ‘?’ is used to separate the Command Area from the Token Area||VAR||1|
The Token Area contains Tokenized fields in the format “TLLDDD…” where
T = token
LL = Length of Data
DDD… = Data (Length = LL)
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.
The following subfield is used in the Command Area of field 11 for Financial Messages.
|1-3||Switch Timeout Value||Defines 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.
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:
|1-2||Message Type||Defines purpose of message.|
|3-5||Transaction Sequence Number||POS transaction sequence number.|
Used in request to define PIN Pad screen to be displayed.
(May be blank or not used.)
|9-11||Completion Code||Used 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.
Note concerning the following Non-Financial Message Types:
The values 13, 16-21 for Message Type are reserved.
Message Type 40 (Quick Chip Message) – Data is also required in the Token Area (Q token).
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 Code Outcome 000 In Informational Prompt and Quick Chip responses: Successful 004 DONE/ACCEPT key pressed with Signature data present 006 ABORT/CANCEL key pressed twice with no detectable signature 008 Signature entry aborted by Simplify 009 Signature entry aborted due to memory being exceeded 010 Memory exhaustion 099 Customer 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).
131 In Quick Chip response: Customer pressed Cancel. 132 In Quick Chip response: Bad Card Type 133 In Quick Chip response: Transaction not allowed. 200 EMV card still inserted 998 Invalid format 999 Timed 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:
Command Requested Action 001 PIN 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 Identifier Status Message 001 Processing Please Wait 002 Slide Card 003 Enter PIN 004 Amount OK 005 Enter Tender Type (Debit / Credit) 006 Cash Back 007 Enter Account Number 008 Enter Expiration Date 009 Enter CVV 010 Enter ZIP Code (AVS Data) 011 Cash Back Other 012 – 016 [Reserved] 017 EMV AID list 019 EMV Account Type Selection 021 EMV card has been removed 022 Swiped not allowed, must use chip 023 EMV fallback
Sample Field 11
The following sample of field 11 is for a Signature Response message sent in response to a Signature Request:
This value is broken down as follows:
|Bytes||Subfield value||Subfield description|
|0-1||02||Message Type (02 = Signature Response)|
|3-5||555||Transaction sequence number (echoed from Signature Request message)|
|6-8||001||Screen ID (echoed from Signature Request message)|
|9-11||004||Completion Code (004 = DONE/ACCEPT key pressed w/ Signature data present)|
Defined Tokens for the Token Area are as follows:
|V||Simplify Version||Simplify response to POS||10|
|S||Identifies the Source Routine of the Error||Simplify error response to POS||40|
|R||Return code from Source Routing||Simplify error response to POS||20|
|E||Actual Error if different from ‘R’||Simplify error response to POS||20|
Transaction Type and Tender Type
(data is optional)
|POS Quick Chip request to Simplify, echoed in response||20|
With the exception of the Q token, the above tokens are for informational purposes only.
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:
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:
This request is for a Sale (=02) transaction. (Tender Type not specified.)