This section provides Hospitality interface descriptions to integrate magnetic and EMV chip and PIN cards transactions to EPOS applications.
Hospitality encapsulates banking magnetic and EMV payment card processing for integrating with EPOS applications. There are two types of interfaces available for integrating with Hospitality.
Hospitality Socket Interface: Provides a simple socket based mechanism to send transaction requests to Hospitality. Hospitality listens on a TCP socket for incoming transaction requests and provides a front-end to the attendant at the till to take chip or swiped card transactions.
Hospitality File Interface: Provides a simple file based mechanism to send transaction requests to Hospitality. Hospitality application polls an inbound directory for incoming transaction request and provides a front-end to the attendant at the till to take chip or swiped card transactions.
Note: For Cashback transactions, Hospitality application sends a cashback request in the file named “output-cashback-xxx.txt” and the corresponding response will be prepared in inputxxx.txt file where xxx is the unique identifier generated by the POS application. See
Hospitality application listens on a TCP/IP port number for transaction requests. Hospitality application opens all sockets in Server mode. The EPOS application should open the relevant sockets in Client mode.
The EPOS application should first establish a connection with the Hospitality (EVTInterfaceServer) application (e.g. request port 10000) and then send a transaction request.
Hospitality responds on the same connection to the transaction request e.g. if the transaction request is sent on socket 10000 to Hospitality by the EPOS application, Hospitality will send the transaction response back on the same socket connection.
The request message has the same format as in the file mode and similarly the response message has the same format as in the file mode.
Note: Configuration of pay at counter will be same as mentioned above except application creates a server to manage multiple instances. This server by default configured on host 127.0.0.1 and port 7000 and its configuration can be modified from property file payatcounter.properties (folder location - YESEFT/properties/payatcounter.properties). See
Since there can be multiple requests pending, and a response can be available for any pending request, a slight change is made in naming convention of Input.txt and Output.txt files. The input file must be named as Inputxxx.txt where xxx is the unique identifier generated by the POS application. The corresponding response will be prepared in Outputxxx.txt file.
For example: transaction reference can be appended to generate names like Input1234.txt.
Submitting Sale Request
Request for polling status of submitted transaction
Request for polling status of submitted closed table
Response of polling request
Response without any polling request
Response of polling request of submitted transaction
Feedback or bugs to report?
Ask our developer community.
Search our documentation, API references and articles.