Scan Data | Documentation

# Scan Data

# Endpoint

http://{terminalIp}/devices/imagescanner/getScanData

# Request

Property	Type	Description
HTTP Headers
Signature	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 of the request.

# Response

Property	Type	Description
HTTP Headers
Content-Type	application/json	Content-type of the payload.
Signature	String	Sha-256 hmac of the JSON payload.
JSON
poyntRequestId	String	Echos the value what was sent in the request.
status	String	"SUCCESS" or "FAILURE"
scanResult	String	String representation of the bar code or QR code.

# Request Example

POST /devices/cat/getScanData HTTP/1.1
Poynt-Client: Java Sample
Poynt-Request-Id: 4950c723-e340-4b2f-a206-262bf60e3594
Signature: 908A49D6BE5BCE7C007FA56B17B9ED09AFA7878BBC40A15AB89B8D1D458D79F2
Content-Type: text/plain; charset=utf-8
Content-Length: 57
Host: 127.0.0.1:55555
Connection: Keep-Alive
Accept-Encoding: gzip
User-Agent: okhttp/3.5.0 =>

{
    "poyntRequestId":"c6194f2b-9fab-4bc8-a0b5-7a272120d905"
}

# Response Example

HTTP/1.1 200 OK
Connection: Keep-Alive
Signature: BE133A911686A36E11C895E9F8E009D96D948BDE65CDA5A6B4F13EEB12182789
Content-Length: 105
Content-Type: application/json <=
{
    "status":"SUCCESS", 
    "poyntRequestId":"c6194f2b-9fab-4bc8-a0b5-7a272120d905",
    "scanResult":"759751002497"}

← Void Print Receipt →