Redeem a pass

POST/passes/{barcode}/redeem

Redeem a pass by its barcode at a gate. Idempotent under an Idempotency-Key header. Returns an outcome of valid, duplicate, or void. (Basic implementation: status + limit only; the full rules engine is part of the scanning/Go stream.)

Parameters

barcodepathrequired

string

The opaque pass barcode (QR payload) being redeemed

Request Body

deviceIdstringScanning device id (optional; devices arrive with the Go stream)

locationstringRedemption point label (optional)

idempotencyKeystringIdempotency key; replays return the original outcome. May also be sent as the Idempotency-Key header.

Response

Redemption processed (see outcome)

Code Samples

No code examples available for this operation.

Try It

Path Parameters

barcode*The opaque pass barcode (QR payload) being redeemed

Request Body

deviceIdScanning device id (optional; devices arrive with the Go stream)

locationRedemption point label (optional)

idempotencyKeyIdempotency key; replays return the original outcome. May also be sent as the Idempotency-Key header.