Scans
Create scan
POST
/
api
/
v1
/
scans
curl --request POST \
--url https://api.passentry.com/api/v1/scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"scan": {
"readerId": "south-gate-1",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"scanType": "barcode",
"loyalty": {
"balance": 10
}
}
}'
{
"validationResponse": {
"status": "successful",
"statusDetail": "",
"readerInstructions": {
"message": "10 points added to your balance. Current balance: 25"
},
"loyalty": {
"balanceChange": "10",
"updatedBalance": "25",
"operation": "add"
}
},
"scanInfo": {
"scanId": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"scanType": "barcode",
"scanValue": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"validationType": "internalValidation",
"status": "successful",
"statusDetail": "",
"scannedAt": "2025-01-21T11:56:37Z",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"passExtId": "4312d68fd106e3e6dd15",
"readerId": "south-gate-1"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.passentry.com/api/v1/scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"scan": {
"readerId": "south-gate-1",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"scanType": "barcode",
"loyalty": {
"balance": 10
}
}
}'
{
"validationResponse": {
"status": "successful",
"statusDetail": "",
"readerInstructions": {
"message": "10 points added to your balance. Current balance: 25"
},
"loyalty": {
"balanceChange": "10",
"updatedBalance": "25",
"operation": "add"
}
},
"scanInfo": {
"scanId": "019488b8-c2fc-7b5b-b5b4-deb2b7f33bdd",
"scanType": "barcode",
"scanValue": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"validationType": "internalValidation",
"status": "successful",
"statusDetail": "",
"scannedAt": "2025-01-21T11:56:37Z",
"passId": "7882e98b-0eba-4625-9223-5221eb8dad7f",
"passExtId": "4312d68fd106e3e6dd15",
"readerId": "south-gate-1"
}
}
Assistant
Responses are generated using AI and may contain mistakes.