4. Connection Status

You can use this service to check whether a specific terminal is connected to the Paywall system.

POST {{Base Address}}/api/terminal/connectivity/check

It is sufficient to send a request to the address provided above. You can use the “Base Address” as needed for both the test environment and the live environment.

Important: In order to use the Terminal Connection Status service, you must send the ‘apikeyprivate’ and ‘apiclientprivate’ parameters in the Header field. PhysicalAPI Address

The required header information to be sent to the service is as follows:

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

The body parameters to be sent to the service are as follows:

JSON

{
    "TerminalId": "6f297d9a-758b-4de4-a837-9d8e37179b8f",
    "TerminalTagCode": ""
}

Response returned from the service:

Parameter	Type	Description
Result	object	Returns the details of the service.
ErrorCode	int	Error code. Returns “0” if the operation is successful.
Succeeded	bool	Returns a true or false value. Returns “true” if the operation is successful.
Failed	bool	Returns a true or false value. Returns “true” if the operation fails.
Message	string	If the operation fails, this is the message describing the error; it provides language support based on the locale parameter.
ClientMessage	string	Returns the constant values of Paywall error codes. You can perform mapping.

JSON

{
    "Result": {
        "IsSocketConnected": true
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}