# Pair Device

Establish a pair connection between a POS App and a GoDaddy Poynt Terminal.

# Endpoint

http://{terminalIp}/devices/cat/pair

# Request

Property Type Description
HTTP Headers
Poynt-Client String The name of the POS application. This name will show in the POS Bridge UI.
Siganture String Sha-256 hmac of the JSON payload.
Content-Type text/plain Even if the payload is a JSON object, POS Bridge parses it as a string, therefore it is important to pass content-type as "text/plain" otherwise the authentication will fail.
JSON
poyntRequestId String UUID

# Response

Property Type Description
HTTP Headers
Content-Type application/json Content-type of the payload.
Siganture String Sha-256 hmac of the JSON payload.
JSON
poyntRequestId String UUID
status String SUCCESS
serialNumber String Serial number of the terminal

NOTE

If the pairing is successful, the response code will be HTTP 200. In case of a failure, the response code will be 400.

# Request Example

POST /devices/cat/pair HTTP/1.1
Host: 10.255.140.195:55555
User-Agent: curl/7.43.0
Accept: */*

Poynt-Client: Awesome POS
Content-Type: text/plain
Signature: f214750ee34bc658522039f8f94419feed55adbe726e3fa77184f8ba145737dd
Content-Length: 57
    {
    "poyntRequestId":"A6A8E65B-9790-4B91-9528-CD2A50F8E907"
    }

# Response Example (Success)

HTTP/1.1 200 OK
Connection: Keep-Alive
Signature: CBB0356E7C7D20958FFBC6C6FC52BCC17E22079AB3CBE5A3843C9A10260C7652
Content-Length: 112
Content-Type: application/json

    {  
    "status":"SUCCESS", 
    "poyntRequestId":"A6A8E65B-9790-4B91-9528-CD2A50F8E907",
    "serialNumber":"P61SWA231FS000383"
    }

# Response Example

HTTP/1.1 400 Unknown
Connection: Keep-Alive
Signature: 13CC5B4C529EA3EE8E96DF8132A3B3A7FD857B68212B4C54D4968AF83FF0AE4C
Content-Length: 134
Content-Type: application/json

{
    "error":{
        "description":"Pairing code mismatch. Please re-pair the devices",
        "errorName":"REQUEST_SIGNATURE_MISMATCH",
        "errorCode":209
    }
}
Last Updated: 12/20/2023, 11:02:09 AM