getRetailerInfo

The getRetailerInfo method allows you to verify the merchant's name and ID. This is useful for confirming that a terminal was configured correctly after installation or setup.

Request

📘

JSON-RPC 2.0

All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Get Startedfor more details on how the requests are structured and sent.

To call this method, the method field should be set to getRetailerInfo, and the params array must include the fixed service name engine.

{
    "jsonrpc": "2.0",
    "method": "getRetailerInfo",
    "id": "136bdaa3",
    "params": [
        "engine"
    ]
}

Request Parameters

See the table below for a description of the available request parameters for this method.

NameTypeDescription
enginestringThe fixed service name

Response

A successful request will return a response similar to the one in the code block below:

{
    "jsonrpc": "2.0",
    "id": "136bdaa3",
    "result": {
        "id": "12970568",
        "name": "MACHINE_TEST"
    }
}

Response Parameters

The table below lists the possible values of the result object:

NameTypeDescription
idstringThe unique retailer (machine) ID
namestringThe name of the retailer