Lookup Gift Card by Code
GET/api/gift-cards/lookup
Resolve a gift card by its code (POS entry) and return it alongside its current balance. Use this when a customer presents a card at checkout.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Permission: pos.operate.
Query parameters:
code(string, required, max 255) — the gift card code.
Returns 200 with { data: <gift card>, balance: <float> }, or 404 { message } when no card matches the code.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.