Message and Communications Protocols

A message using the Elavon Gateway API format consists of a list of fields, each assigned a field number. The field number (which can be 0-filled to 4 characters or just the number up to 4 characters) is followed by a comma which is followed by the field value. Each line is terminated with a <CR><LF>. Alternatively each line might be terminated by a UNIX <LF>. The message is terminated with an EOT.

Control Characters are defined as follows:

<CR> = (0x0D) 1 byte, hex D

<LF> = (0x0A) 1 byte, hex A

EOT = (0x04) 1 byte, hex 4

error_outline

note

Sample messages shown in this document do not show the control characters.

The communications protocol between the POS process and Simplify is TCP/IP, or RS-232 (Serial), or PPP with TCP/IP over RS-232.

Simplify supports routing Fusebox messaging via the POS (using the same protocol as configured for POS messaging). See Appendix G - Routing Fusebox Messaging through the POS for details.

TCP/IP

TCP/IP communications between the POS and Simplify can be by wired ethernet, Wifi or Bluetooth transport to the base. The availability of these communication methods is device-dependent.

In most systems, Simplify will act as the TCP/IP server. The POS process will act as a TCP/IP client and initiate the connection to Simplify.

  • Exception: For Pay@Table systems, the POS process will act as the TCP/IP server. Simplify will act as a TCP/IP client and initiate the connection to the POS.

Simplify-POS messaging can use plain TCP/IP or TCP/IP with TLS 1.2. Depending on security configuration, a certificate may be needed if TLS is used.

RS-232 (Serial)

Appendix B - Simplify Serial Communication Protocol describes the Simplify RS-232 communication protocol.

Simplify RS-232 communication could optionally be over USB emulating RS-232.

PPP under RS-232 (Serial)

Simplify supports PPP (Point to Point Protocol) communications over RS-232. Using this protocol for the transport layer allows customers to communicate via TCP/IP over a RS-232 physical link.

The Simplify PIN Pad will be the PPP client and communicate with a PPP server on the customer network. Elavon will set the PIN Pad to receive the following data from the PPP server: (1) A host IP address to use for TCP/IP communications between the PIN Pad and Fusebox. (2) A HEM/IngEstate server address to use for TCP/IP communications between the PIN Pad and HEM/IngEstate.

There will be three TCP/IP sockets:

  • One socket is from the POS to Simplify. The POS will be the socket client and Simplify will be the socket server.

  • Another socket is from Simplify to Fusebox. FuseBox will be the socket server and Simplify will be the socket client. This socket is non-persistent (as usual) and is secured by TLS 1.2.

  • Another socket is from Simplify to the HEM/IngEstate server. HEM/IngEstate will be the socket server and Simplify will be the socket client.

Apart from interaction with the PPP server, Simplify TCP/IP communications under PPP will follow the usual Simplify TCP/IP rules.