1. Pair/Request

You can use this service to send a request to establish an async connection to your terminals.

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

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: In order to use the Async Matching Request 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 merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

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

Note: Only one of the TerminalId or TerminalTagCode parameters can be used for the transaction. If you attempt to send both at the same time, 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	-	Your terminal's ID
TerminalTagCode	string	Yes/No	25	Tag code

Response from the service:

Parameter	Type	Description
Result	object	It returns the details of the service.
ErrorCode	int	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 message related to the error, and it provides language support according to the locale parameter.
ClientMessage	string	It returns the fixed values of Paywall error codes. You can perform mapping.

JSON

{
    "Result": {
        "PairAsyncRequestId": "4c1bcf08-d842-4e4a-9570-449c1f364f5c",
        "PairCode": "902997"
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}

Parameter	Type	Description
PairAsyncRequestId	Guid	It is the matching request ID. It is used in other required services. You should store it on your side.
PairCode	string	The matching code should also be stored on your side and communicated to the device user for input on the device.