1. Pair/Request

You can use this service to send a request to establish a sync connection with your terminals.

POST {{Base Address}}/api/pair/sync/request

It will be enough 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 production environment.

Important: To use the Sync Matching Request service, you must send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' section.

PhysicalAPI Address

The headers required to send a request to the service are 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 information to be sent to the service is as follows:

Caution: A transaction can only be processed with one of the parameters, either TerminalId or TerminalTagCode. If both are sent simultaneously, the service will return a warning.

JSON

{
    // "TerminalId": "38e895c3-1a9a-4b73-8816-8557d1d031d6"
    "TerminalTagCode": "dükkan_1"
}

Parameter	Type	Compulsory	Length	Description
TerminalId	Guid	Yes/No	-	The ID of your terminal.
TerminalTagCode	string	Yes/No	25	Tag code.

The response returned by the service:

Parameter	Type	Description
Result	object	Returns the details of the service.
ErrorCode	int	Error code. If the transaction is successful, it returns a value of '0'.
Succeeded	bool	Returns a true or false value. If the transaction is successful, it returns a value of 'true'.
Failed	bool	Returns a true or false value. If the transaction is unsuccessful, it returns a value of 'true'.
Message	string	If the transaction is erroneous, this is the message associated with 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": {
        "PairRequestId": "765c1ea9-bf03-4ee5-8d77-8e4893e5afe3",
        "TerminalId": "38e895c3-1a9a-4b73-8816-8557d1d031d6",
        "PairCode": "949161"
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}

Parameter	Type	Description
PairRequestId	Guid	It is the matching request ID. It is used in other required services. You should store it on your side.
TerminalId	Guid	The identity information of the terminal you requested.
PairCode	string	The matching code should also be stored on your side and communicated to the device user for entry into the device.