2. Pair/Request/Approve

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

PUT {{Base Address}}/api/pair/async/confirm

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 Confirmation 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:

{
    "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 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.

{
    "Result": {
        "TerminalPairId": "616e4bc7-8661-4040-86b8-e660b936b85f"
    },
    "Failed": false,
    "Message": null,
    "ClientMessage": null,
    "Succeeded": true
}
Parameter
Type
Description
TerminalPairId

Guid

It is not mandatory to store. It is the device's matching identity information.

Last updated