> ## Documentation Index > Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # Redeem value from an instrument > Draws `amountCents` from the instrument identified by its BEARER CODE and returns the instrument at its reduced balance (`depleted` once it reaches zero). Keyed by code, not id, because that is what the till physically has. IRREVERSIBLE — there is no un-redeem verb; check the balance with the by-code lookup first. NOT IDEMPOTENT — there is no dedup key, so a retried call draws the amount a SECOND time; if a request times out, re-read the instrument by code and compare the balance before retrying. 404s on an unknown code; 422s when the instrument is not `active`, has expired, or the draw exceeds the remaining balance. Online-only: it cannot be queued offline. ## OpenAPI ````yaml /openapi.json post /v1/giftcards/redemptions openapi: 3.0.3 info: title: Solya POS API version: 1.0.0 description: >- The Solya POS backend HTTP surface. Every documented operation is agent-ready: it carries an `operationId`, an agent-facing `description`, the `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`. Success responses return the payload as raw JSON; failures return the `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`). servers: - url: / description: The backend, relative to its deployed origin. security: [] paths: /v1/giftcards/redemptions: post: tags: - Instruments summary: Redeem value from an instrument description: >- Draws `amountCents` from the instrument identified by its BEARER CODE and returns the instrument at its reduced balance (`depleted` once it reaches zero). Keyed by code, not id, because that is what the till physically has. IRREVERSIBLE — there is no un-redeem verb; check the balance with the by-code lookup first. NOT IDEMPOTENT — there is no dedup key, so a retried call draws the amount a SECOND time; if a request times out, re-read the instrument by code and compare the balance before retrying. 404s on an unknown code; 422s when the instrument is not `active`, has expired, or the draw exceeds the remaining balance. Online-only: it cannot be queued offline. operationId: redeemGiftcard requestBody: required: true content: application/json: schema: type: object properties: code: type: string minLength: 1 amountCents: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - code - amountCents example: code: GC-4F2A-9B71 amountCents: 1500 responses: '200': description: The instrument after the draw, carrying its new balance and status. content: application/json: schema: type: object properties: id: type: string minLength: 1 kind: type: string enum: - gift_card - credit_note - store_credit code: type: string minLength: 1 currency: type: string minLength: 3 maxLength: 3 initialBalanceCents: type: integer minimum: 0 maximum: 9007199254740991 balanceCents: type: integer minimum: 0 maximum: 9007199254740991 status: type: string enum: - active - depleted - void customerId: type: string minLength: 1 expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - kind - code - currency - initialBalanceCents - balanceCents - status additionalProperties: false description: >- The instrument after the draw, carrying its new balance and status. example: id: gc-2026-000142 code: GC-4F2A-9B71 kind: gift_card currency: EUR initialBalanceCents: 5000 balanceCents: 2000 status: active expiresAt: '2028-01-31T23:59:59.000Z' '400': description: >- The request failed schema validation; `error.fieldErrors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: No valid credential was presented — send a bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The actor is authenticated but lacks the required `pos.*` scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: No resource matches the addressed identifier. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: The request is well-formed but violates a domain rule. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error — safe to retry idempotent requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ValidationErrorResponse: type: object required: - error additionalProperties: false description: >- A `VALIDATION_FAILED` envelope carrying the offending fields in `fieldErrors`. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED message: type: string statusCode: type: integer fieldErrors: type: array description: >- One entry per rejected field: the field path and why it was rejected. items: type: object required: - field - message additionalProperties: false properties: field: type: string description: Dot-path of the offending field. message: type: string description: Why the field was rejected. ErrorResponse: type: object required: - error additionalProperties: false description: The uniform failure envelope every non-2xx response returns. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - BUSINESS_RULE_VIOLATION - INTERNAL_ERROR description: >- Machine-readable kernel `ResultCode` — branch on this, not on `message`. message: type: string description: >- Human-readable explanation. Safe to surface; never leaks server internals. statusCode: type: integer description: >- The HTTP status, mirrored into the body so a client need not read headers. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- `Authorization: Bearer `. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same `pos.*` scope vocabulary the route guards enforce. ````