Simplify-Controlled Field Definitions

On this page:

This page describes the following fields whose definition is controlled by Simplify:

Since Fusebox does not modify these fields (and in some cases, does not receive them), they allow the POS and Simplify to communicate with each other with no concern for how Fusebox might affect the data.

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 Allow Pre-Tendering (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 (Tran 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.

The following table shows supported Command Area subfields for each defined Non-Financial message (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
unless stated)
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
Allow Pre-Tendering
Request/Response **
40Completion Code
(only in response)
Print Request Message
Request/Response
45(not sent)
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 (Allow Pre-Tendering Message) – Data is also required in the Token Area (Q token).

  • Message Types 08, 09, 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, Allow Pre-Tendering or Fast Graphics Download 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 (Signature response)
099Customer pressed CANCEL after entering detectable Signature
100
  • Transaction not allowed for device.
  • PIN Pad is currently busy.
  • For Signature response: Unable to create sigcap object or signature too small two times.
  • In Allow Pre-Tendering response: error (e.g. Pre-Tendering not enabled).
112In Fast Graphics Download response: Download error.
113In Fast Graphics Download response: File error.
131In Allow Pre-Tendering response: Customer pressed Cancel.
132In Allow Pre-Tendering response: Bad Card Type
133In Allow Pre-Tendering 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 IdentifierPIN Pad Status
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
025Waiting for Cashier

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 Allow Pre-Tendering 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 an Allow Pre-Tendering (36-40) request. The format of the Q token is as follows:

QaabbFScccFS, where:

  • Q = Allow Pre-Tendering 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 Allow Pre-Tendering 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.)

Field 5001 (Non-Financial Data)

Field 5001 is used in the following types of messages as follows:

  • In Non-Financial Messages (Tran Type 36):
    • Used in requests and/or responses for most Message Types:
      • In request, used to define display or screen operation.
      • In response, used to indicate outcome of requested operation. In Informational Prompting Messages (36-14), this field returns customer feedback.
    • Details are message-specific. For more information, see the formats and sample messages given under Non-Financial Messages.
  • In Financial Responses:
    • For auto signature-eligible transactions, Field 5001 is used in the financial response to inform the POS whether Simplify is performing auto signature processing for the transaction. For details, see Auto Signature.
  • In Mifare Activation Response:
    • The POS can activate Mifare tap by sending a request to Simplify with “M” or “m” in API 0003. For valid tap, Simplify will extract the UID, and send it to the POS in the response as token 300 in Field 5001 (no Fusebox message). E.g. 5001,300014042A18C25B6285

Field 5070 (Simplify Load Information)

Field 5070 is used in financial responses and the Version Number Inquiry (36-06) Response to return information about the PIN Pad and its Simplify implementation. This includes the Simplify version number, other Simplify load information (e.g. parameter file version numbers, TMS Identifier, build number, patch level), and PIN Pad serial number data. The maximum size of this field is 256 bytes.

A current sample of this field is as follows:

5070,Merchant: Test01;Simplify: N-OG-2.03.12818;PARM: 2.28.1;TENDERDEF: 2.28.2;EMVPARM: EMVPARM-E4-2– ;TMS: 88802013;Package: 2.28.5;Full SN: 181052213011023907225277;Injected SN: ;Build: 28118-PatchN

Subfield NameCurrent valueMeaning
MerchantTest01Identifies implementation by merchant name.
SimplifyN-OG-2.03.12818Simplify version number
PARM2.28.1parm.fil parameter file version
TENDERDEF2.28.2tenderdef.fil parameter file version
EMVPARMEMVPARM-E4-2–emvparm.fil parameter file version
TMS88802013TMS identifier of the PIN Pad
Package2.28.5ID of package used to build current load
Full SN181052213011023907225277Serial number shown on the back of the device
Injected SNSerial number injected during the KIA process
Build28118-PatchNVersion number, Build number, Patch level

Field 5071 (Card/Cardholder Present?)

Field 5071 is used in financial requests from the POS to inform Simplify whether the card and cardholder were present for the transaction. This field is only used by Simplify to help set field 47, and is not sent to Fusebox. If sent in the request, this field will be echoed in the response.

Supported values are:

  • 0=neither present (including all manual entry with cardholder not present)
  • 1=both present
  • 2=only cardholder present

If the value in 5071 is invalid or not present, Simplify will use a default value of 1. However Elavon recommends sending this field in all financial requests, using the value that reflects the actual transaction environment.

Field 5104 (Tip Prompting)

note

This section describes the use of Field 5104 for non-Pay@Table systems. This API is also supported for Pay@Table, with different rules; see Pay@Table Field Formats and Descriptions under Field 5104 for details.

Supported settings

  • Set Tip flag.

  • Define Tip prompting text.

  • Define up to three Tip percentages.

See below under Usage for details.

Supported messages

  • Financial requests (echoed in Simplify response).

Format

API 5104 format is as follows:

aa;bb;ccFSdFSe where:

  • aa, bb, cc = Tip percentages. (1 or 2 digits supported. Percentage sign is assumed.)
  • d = Tip flag (0=disable, 1=enable).
  • e = Tip prompting text. (Can include \n to indicate the start of an additional line of text.)

Note: FS represents a 1 byte field separator (hex 1C).

Semi-colons (;) and field separators (FS) are required, even if some subfields are null.

The maximum length of API 5104 is 30 bytes.

note

The Lane 3000 supports a fourth percentage on the Select a Tip screen. One of the percentage fields can be used to display the Custom Tip Amount screen when selected (set field to Cust_Tip). Field 5104 format for this device differs only by including this additional percentage subfield.

Usage

Overrides configured Tip settings for the current transaction:

  • Tip Flag
    • 0 – No Tip prompting. Total transaction amount = Base amount (no tip).
    • 1 – If Tip percentages are defined, the Select a Tip screen will be displayed showing the percentages/corresponding Tip amounts. Else the Enter Custom Tip Amount screen will be displayed.
  • Tip Percentages
    • Used if Tip Flag = 1 (see above).
  • Tip Prompting Text
    • Replaces configured prompt on the Select a Tip screen (if displayed) and the Enter Custom Tip Amount screen (if displayed).

Samples

  • 5104,15;18;20FS1FSEnter Tip
    Simplify will display the Select a Tip screen showing the requested percentages/corresponding amounts. Prompt will be “Enter Tip”.

  • 5104,;;FS1
    Simplify will go directly to the Enter Custom Tip Amount screen. Configured prompting text will be used.

  • 5104,0;15;18;Cust_TipFS1 (Lane 3000 only)
    Simplify will display the Select a Tip screen showing the requested percentages. Pressing the fourth button (verbiage configurable) will go to the Enter Custom Tip Amount screen. Configured prompting text will be used.