Get the configuration of the device

GET

/api/config/v4

This endpoint returns the project-specific configuration of the device. This includes details such as the project name, unit name, site name, available payment types, and the credit-to-currency factor. The credit-to-currency factor is used to convert credits to the equivalent currency amount.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Responses

🟢200OK

application/json

The configuration of the device

Body

🟠401Unauthorized

🟠405405

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://192-168-1-1.xip.get.systems:9443/api/config/v4' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - Example 1

{
    "data": {
        "projectName": "GET Roadshow 2025",
        "unitName": "Beverage",
        "siteName": "Bar Mainstage Left",
        "deviceId": "AMUU-Z",
        "creditsSymbol": "CDTS",
        "currencySymbol": "€",
        "decimalSeparator": ".",
        "decimalPlacesCredits": 2,
        "decimalPlacesCurrency": 2,
        "creditToCurrencyFactor": "1",
        "paymentTypes": [
            {
                "id": "4eda6f3c-d75c-489f-b7b5-6fc71a67ef27",
                "name": "Cashless",
                "type": "Cashless"
            }
        ]
    }
}

Modified at 2025-02-13 14:31:55

Basic Information

Cancel an active job