4. Pair/Request/Cancel

You can use this service to cancel your async matching request with the terminal.

DELETE {{Base Address}}/api/pair/async/request/delete

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 production environment.

Important: In order to use the Async Matching Request Cancellation 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 Key obtained from the merchant panel.

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

JSON

{
    "PairAsyncRequestId": "4c1bcf08-d842-4e4a-9570-449c1f364f5c"
}

Parameter	Type	Compulsory	Length	Description
PairAsyncRequestId	Guid	Yes	-	Matching request ID

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 error message, and it provides language support based on the locale parameter.
ClientMessage	string	It returns the fixed values of Paywall error codes. You can perform mapping.

JSON

{
    "Result": {
        "PairRequestId": "93d27c03-c38e-4711-819b-c796f009c17f"
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}