Terminal Information

The /info request allows you to confirm or identify terminals with a simple GET request sent to an IP address on your local network. There are multiple use cases for this feature, for example:

• The EPOS can send to all IP's in the local range, and build an accurate picture of all axept® PRO terminal's on site at that time
• The EPOS can send to a specific IP to match the IP and Serial Number up, allowing one less step in EPOS configuration
• The EPOS can use this to periodically monitor the devices on site as a way to maintain the wider estate.

GET /info

URL

https://(TerminalIP):8080/POSitiveWebLink/1.1.0/rest/info

An HTTPS GET request should be sent to the above URL with the following parameters:

GET /reports Header Parameters
Field Name	State	Data Type	Description
Authorization	Mandatory	String	This field should be populated with a value of Bearer 6945595921271780

note

This is the only REST endpoint that does not require the tid (Device Serial Number) as a parameter.

GET Request Example

GET https://192.168.0.121:8080/POSitiveWebLink/1.1.0/rest/info
HTTP/1.1
Content-Type: application/json
Authorization: Bearer 6945595921271780
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Host: 192.168.0.75:8080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive

DeviceInfo Object response fields

In response to the GET, axept® PRO will return the DeviceInfo object containing the following fields:

DeviceInfo Object
Field Name	Data Type	Description
axeptProVersion	String	The current software version of the payment application.
batteryLevel	String	The current battery level of the terminal, expressed as a percentage e.g. "86%"
connectionInfo	Object	An Object containing several details related to the terminals network connection.
departmentId	String	The Department ID for the currently logged in user. This will only show if axept® PRO is logged in to a Department.
firmwareVersion	String	The current firmware version installed on the terminal.
manufacturer	String	The device manufacturer e.g. "PAX"
mid	String	If available, the primary Merchant ID configured on the terminal. Only valid following terminal activation.
model	String	The model name as provided by the operating system e.g. "A920Pro"
posId	String	The unique identifier that the manufacturer assigns to the terminal.
serialNumber	String	The serial number of the terminal. This may or may not be the same as posId.
These additional fields will only be populated if axept® PRO is currently logged in to a valid user.
tid	String	The terminal ID allocated to the logged in user. Our terminals use 'soft tids' so this can change depending on which department has been logged into.
userId	String	The user ID for the logged in user.
userName	String	The user name for the logged in user.

caution

The user password will never be returned from this endpoint.

connectionInfo Object response fields

connectionInfo Object
Field Name	Data Type	Description
connectionType	String	The type of connection. Possible values are: Wi-Fi N/A
batteryLevel	String	The current battery level of the terminal, expressed as a percentage e.g. "86%"
The remaining fields are part of an Object based on the connectionType e.g. wifiInfo.
gateway	String	The IP address of the Gateway the terminal connection is using.
ipAddress	String	The IP address the terminal connection is using.
signalStrength	String	If applicable, the strength of the Wi-Fi connection.
subnetMask	String	The IP address of the Subnet Mask the terminal connection is using.

GET Example Response

    "DeviceInfo": {
        "axeptProVersion": "1.00.48-11101",
        "batteryLevel": "86%",
        "connectionInfo": {
            "connectionType": "Wi-Fi",
            "wifiInfo": {
                "gateway": "192.168.0.1",
                "ipAddress": "192.168.0.121",
                "signalStrength": "100% Excellent Signal",
                "subnetMask": "0.0.0.0"
            }
        },
        "departmentId": "118677",
        "firmwareVersion": "PayDroid_8.1.0_Sagittarius_V11.1.33_20220112",
        "manufacturer": "PAX",
        "mid": "82603014000",
        "model": "A920Pro",
        "posId": "1850609592",
        "serialNumber": "1850609592"
        "tid": "03014042",
        "userId": "4321",
        "userName": "4321"
    }
}