Installation
...
5) For each of the HTTP requests created in Postman, set the terminalIp parameter to the IP Address of the Wi-Fi Network, and set the terminalPort parameter to the TCP/IP Port (which is going to be 8080). FinallyThen, set the terminalId Parameter to the unique identifier for each POS Terminal. Finally, if there are any additional parameters for that specific HTTP request, add them.
6) Send the respective HTTP request.
API Documentation
GET /ping
/revenue-terminals/ping
Pings the terminal to establish a WebSocket connection.
Parameters should be passed as query parameters.
| The IP address of the terminal |
| The port number of the terminal for the connection |
| An identifier for the terminal |
POST /card-sale
/revenue-terminals/card-sale
Processes a card sale transaction.
Parameters should be passed as query parameters.
| The IP address of the terminal |
---|---|
| The port number of the terminal for the connection |
| The monetary amount of the card sale transaction (in decimal format) |
| An identifier for the terminal |
...
Processes a debit sale transaction.
Parameters should be passed as query parameters.
| The IP address of the terminal |
---|---|
| The port number of the terminal for the connection |
| The monetary amount of the debit sale transaction (in decimal format) |
| The monetary amount of the debit sale transaction (in decimal format) to be added |
| An identifier for the terminal |
POST /cancel-sale
/revenue-terminals/cancel-sale
Cancels the current sale transaction.
Parameters should be passed as query parameters.
| The IP address of the terminal |
| The port number of the terminal for the connection |
| An identifier for the terminal |
POST /void-sale
/revenue-terminals/void-card-sale
Voids the current sale transaction.
Parameters should be passed as query parameters.
| The IP address of the terminal |
| The port number of the terminal for the connection |
| The trace number of the transaction to be voided |
| The monetary amount of the sale transaction to be voided (in decimal format) |
| An identifier for the terminal |
POST /settlement
/revenue-terminals/settlement
Processes a settlement request.
Parameters should be passed as query parameters.
| The IP address of the terminal |
| The port number of the terminal for the connection |
| An identifier for the terminal |
POST /qr-sale
/revenue-terminals/qr-sale
Processes a QR sale transaction.
Parameters should be passed as query parameters.
| The IP address of the terminal |
---|---|
| The port number of the terminal for the connection |
| The monetary amount of the QR sale transaction (in decimal format) |
| An identifier for the terminal |