3. Synchronize

You can use this service for the synchronization between your physical POS terminals and Paywall-Provider.

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.

POST {{Base Address}}/api/terminal/{ConnectionId}/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.

Important: To use the Terminal Synchronization Command service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PhysicalAPI Address

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

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

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

JSON

{
  "ConnectionId": 109334
}

The response returned from the service:

Parameter	type	Description
Result	object	It returns the details of the service.
ErrorCode	int	The error code. If the operation is successful, it returns the value '0'.
Succeeded	bool	It returns a true or false value. If the operation is successful, it returns the value 'true'.
Failed	bool	It returns a true or false value. If the operation is unsuccessful, it returns the value 'true'.
Message	string	If the operation is faulty, this is the error message related to it. It provides language support based on the locale parameter.
ClientMessage	string	It returns the fixed values of the Paywall error codes. You can perform mapping.

JSON

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