3. Request/Cancel

You can use this service to cancel the sync match request with your terminal.

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

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

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

PhysicalAPI Address

The header information 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 to be sent to the service is as follows:

{
    "PairRequestId": "4c1bcf08-d842-4e4a-9570-449c1f364f5c"
}
Parameter
Type
Compulsory
Length
Description
PairRequestId

Guid

Yes

-

Match request ID

Response returned from the service:

Parameter
Type
Description

Result

object

Returns the details of the service information.

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 related to the error, with language support provided according to the locale parameter.

ClientMessage

string

Returns the constant values of Paywall error codes. You can perform mapping.

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

Last updated