# 3. Synchronize

{% hint style="info" %}
**Example Flow:** You have deployed 100 new terminals for your company. Paywall synchronizes terminals at regular intervals, but according to your process, you can trigger the synchronization. You can issue a synchronization command without waiting for Paywall's scheduled period.
{% endhint %}

<mark style="color:green;">`POST`</mark> `{{Base Address}}/api/terminal/sync`

It will be sufficient to send a request to the address provided above. You can use the 'Base Address' as you wish for both the test environment and the live environment.

{% hint style="info" %}
Important: To use the **Terminal Synchronization** Command service, you need to send the '**apikeyprivate**' and '**apiclientprivate**' parameters in the 'Header' field.

\
[<mark style="color:green;">**PhysicalAPI Ad**</mark>](/payment-orchestration-integration-document/environment.md)<mark style="color:green;">**dress**</mark>
{% endhint %}

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

<table><thead><tr><th width="243">Parameter</th><th width="106.33333333333331">type</th><th width="142">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 member merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Client obtained from the member merchant panel.</td></tr></tbody></table>

**The body information that needs to be sent to the service is as follows:**

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

```json
{
    "ConnectionId": "70b2190b-e47b-455f-b05e-8c132a05534c"
}
```

{% endtab %}
{% endtabs %}

**The 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>It returns the details of the service.</td></tr><tr><td>ErrorCode</td><td>int</td><td>The error code. If the operation is successful, it returns the value '0'.</td></tr><tr><td>Succeeded</td><td>bool</td><td>It returns a true or false value. If the operation is <mark style="color:green;">successful</mark>, it returns the value 'true'.</td></tr><tr><td>Failed</td><td>bool</td><td>It returns a true or false value. If the operation is <mark style="color:red;">unsuccessful</mark>, it returns the value 'true'.</td></tr><tr><td>Message</td><td>string</td><td>If the operation is faulty, this is the error message related to it. It provides language support based on the locale parameter.</td></tr><tr><td>ClientMessage</td><td>string</td><td>It returns the fixed values of the Paywall error codes. You can perform mapping.</td></tr></tbody></table>

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

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/physical-pos/3.-terminal/3.-synchronize.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
