PUT api/hardware/payment-terminal/pairing
Reports the outcome of a POSitive WebLink terminal pairing that the server asked for (the CNPPairing XMPP message): the terminal's auth token on success, or the error. The Hardware ID comes from the Authorization header, so a workstation can only complete its own pairing request. Responses: 204 when accepted. 400 if RequestId is missing. 409 if the request has expired, has already completed, or isn't this workstation's pending request.
Request Information
URI Parameters
None.
Body Parameters
The RequestId from the pairing message, with the auth token or the error.
PaymentTerminalPairingResultDT| Name | Description | Type | Additional information |
|---|---|---|---|
| RequestId |
The RequestId from the pairing message, which ties this result to the request. |
globally unique identifier |
None. |
| AuthToken |
On success: the token the terminal issued. |
string |
None. |
| Error |
On failure: what went wrong. Shown to the admin who started the pairing. |
string |
None. |
Request Formats
application/json, text/json
{
"requestId": "07e4f896-2ffe-4c31-b97e-286cc342c7a3",
"authToken": "sample string 2",
"error": "sample string 3"
}
Response Information
Resource Description
None.