Installation & Testing
Build and Run the Backend Wavelet POS Software.
Install Postman from this link
Create HTTP requests for each endpoint.
Click on New > HTTP
Select the appropriate request method and enter the specific endpoint prefixed with
http://localhost:8085[INSERT-YOUR-PORT-NUMBER-HERE]
Connect POS Terminal to the SAME Wi-Fi Network as the device running the Backend Wavelet POS Software. Note down the IP IPv4 Address of the Wi-Fi Network.
From the POS Terminal, go to Management > Config. Input the password as ‘88888888’the System Administrator Password (This can vary, but at the time of writing was ‘88888888’) . Go to EDC. Then scroll down to TCP/IP and note down the TCP/IP Port (which is going to be Again, this can vary, but at the time of writing it was 8080).
For each of the HTTP requests created in Postman, do the following:
Set the terminalIp parameter to the IP IPv4 Address of the Wi-Fi Network
Set the terminalPort parameter to the TCP/IP Port (which is going to be 8080)
Set the terminalId Parameter to the unique identifier for each POS Terminal
If there are any additional parameters for that specific HTTP request, add them.
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 |
POST /my-debit-sale
/revenue-terminals/my-debit-sale
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 my debit sale transaction (in decimal format) |
| The monetary amount of the my 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 |
...