> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/payment-orchestration-integration-document/physical-pos/3.-terminal/4.-connection-status.md).

# 4. Connection Status

<mark style="color:green;">`POST`</mark> `{{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.

{% hint style="info" %}
**Important:** In order to use the Terminal Connection Status service, you must send the **‘apikeyprivate’** and **‘apiclientprivate’** parameters in the **Header** field.\
\
[<mark style="color:green;">**PhysicalAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

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

<table><thead><tr><th width="205.19921875">Parameter</th><th width="106.33333333333331">Type</th><th width="148.421875">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>The Private Key obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Client obtained from the merchant panel.</td></tr></tbody></table>

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

{% tabs %}
{% tab title="JSON" %}

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

{% endtab %}
{% endtabs %}

**Response returned from the service:**

<table><thead><tr><th width="182">Parameter</th><th width="107.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Result</td><td>object</td><td>Returns the details of the service.</td></tr><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns “0” if the operation is successful.</td></tr><tr><td>Succeeded</td><td>bool</td><td>Returns a true or false value. <mark style="color:green;">Returns</mark> “true” if the operation is successful.</td></tr><tr><td>Failed</td><td>bool</td><td>Returns a true or <mark style="color:red;">false</mark> value. Returns “true” if the operation fails.</td></tr><tr><td>Message</td><td>string</td><td>If the operation fails, this is the message describing the error; it provides language support based on the locale parameter.</td></tr><tr><td>ClientMessage</td><td>string</td><td>Returns the constant values of Paywall error codes. You can perform mapping.</td></tr></tbody></table>

{% tabs %}
{% tab title="JSON" %}
{% code overflow="wrap" lineNumbers="true" %}

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

{% endcode %}
{% endtab %}
{% endtabs %}
