> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Redeem a catalog item

> Redeem a reward catalog item for a participant.

Redeems a specific reward from the program's catalog on behalf of a participant. For `UNIT_BASED` rewards, specify `quantity` (defaults to 1); for `AMOUNT_BASED` rewards, specify `amount`. The total cost deducted from the participant's balance is calculated as `quantity * unit_cost` for unit-based rewards.

The program must be `ACTIVE` (not archived or suspended), and the reward must belong to the specified program. Ensure the reward's `status` is `ACTIVE` and within its `available_from`/`available_until` window before calling this endpoint.

Inventory is tracked automatically. Each successful redemption increments `redeemed_count` both globally and per participant. When a reward's `redeemed_count` reaches its `max_total`, the reward auto-transitions to `OUT_OF_STOCK` status and further redemption attempts will fail. Per-participant limits are enforced via `max_per_participant` if configured on the reward.

Pass an `idempotency_key` to safely retry requests. Duplicate requests return `200` with the existing redemption instead of `201`.

<Note>
  For usage patterns and examples, see the [Redemptions guide](/guides/redemptions).
</Note>


## OpenAPI

````yaml POST /v1/participants/{id}/redemptions/items
openapi: 3.0.3
info:
  contact:
    email: support@scrip.dev
    name: Scrip Support
    url: https://scrip.dev/support
  description: >-
    Universal Incentive Infrastructure API for managing loyalty programs,
    rewards, and participant balances.


    Scrip provides a complete backend for building incentive and loyalty
    programs. Core concepts:

    - **Programs**: Containers for incentive logic (e.g., "Q1 Sales Bonus",
    "Customer Loyalty")

    - **Assets**: The currency or points being tracked (e.g., "Bonus Points",
    "Cash Rewards")

    - **Participants**: Users who earn and spend assets (identified by
    external_id)

    - **Groups**: Collections of participants for team-based incentives

    - **Rules**: Automated reward logic triggered by events

    - **Events**: Actions that trigger rule evaluation (e.g., "purchase",
    "referral")


    Response formats:

    - **Collection endpoints** return: {"data": [...], "pagination":
    {"has_more": true, "next_cursor": "..."}}

    - **Single-resource endpoints** return the resource directly

    - **Errors** return: {"code": "...", "message": "...", "details": {...}} —
    `details` is an optional object, present on input errors only
  license:
    name: Proprietary
    url: https://scrip.dev/license
  termsOfService: https://scrip.dev/terms
  title: Scrip API
  version: '1.0'
servers:
  - url: https://api.scrip.dev
security: []
tags:
  - description: >-
      Manage incentive programs. Programs are the top-level container for all
      incentive logic.
    name: Programs
  - description: >-
      Manage asset types (currencies, points). Assets define what participants
      can earn and spend.
    name: Assets
  - description: >-
      Manage participants and their balances. Participants are identified by
      external_id from your system.
    name: Participants
  - description: Manage participant groups for team-based incentives.
    name: Groups
  - description: >-
      Manage automated reward rules. Rules define conditions and actions
      triggered by events.
    name: Rules
  - description: Ingest events that trigger rule evaluation and reward distribution.
    name: Events
  - description: Transfer assets between participants.
    name: Transfers
  - description: Access ledger summaries and program activity reports.
    name: Reporting
  - description: >-
      Redeem participant balances for rewards. Supports raw amount redemptions
      and catalog item redemptions.
    name: Redemptions
  - description: >-
      Manage the reward catalog. Create and manage redeemable items with
      inventory tracking.
    name: Rewards
  - description: >-
      Schedule and manage automated event dispatching. Automations generate
      events on cron schedules, at specific times, or by evaluating participant
      state.
    name: Automations
  - description: >-
      Manage tier types and levels within programs. Tiers define status
      hierarchies that participants progress through based on qualification
      rules.
    name: Tiers
  - description: Inspect double-entry ledger records for auditing and reconciliation.
    name: Journal Entries
  - description: >-
      Manage webhook endpoints and delivery logs. Webhooks notify your
      application of real-time events via HTTP POST with HMAC-SHA256 signatures.
    name: Webhooks
paths:
  /v1/participants/{id}/redemptions/items:
    post:
      tags:
        - Redemptions
      summary: Redeem a catalog item
      description: Redeem a reward catalog item for a participant.
      operationId: createRedemptionItems
      parameters:
        - description: Participant ID
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handlers.RedeemItemRequest'
        description: Catalog item redemption details
        required: true
        x-originalParamName: request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.RedemptionResponse'
          description: Duplicate request (idempotency key matched, returns existing record)
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.RedemptionResponse'
          description: Redemption created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrBadRequestResponse'
          description: 'Validation failed (code: validation_error | bad_request)'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnauthorizedResponse'
          description: 'Missing or invalid credentials (code: unauthorized)'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrNotFoundResponse'
          description: 'Participant, program, or reward not found (code: not_found)'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrConflictResponse'
          description: >-
            Reward unavailable/inactive, inventory limit exceeded, or
            participant inactive (code: conflict)
        '415':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnsupportedMediaTypeResponse'
          description: 'Content-Type must be application/json (code: unsupported_media_type)'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnprocessableResponse'
          description: >-
            Insufficient balance, archived asset, or program not active (code:
            insufficient_funds | asset_archived | program_inactive)
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrInternalResponse'
          description: 'Internal server error (code: internal_error)'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    handlers.RedeemItemRequest:
      additionalProperties: false
      properties:
        amount:
          description: Amount to redeem (AMOUNT_BASED rewards only, decimal string)
          example: '50.00'
          type: string
        description:
          description: >-
            Optional context for this redemption, used in journal entries (max
            500 chars)
          example: Gift card redemption
          type: string
        idempotency_key:
          description: Prevents duplicate redemptions when retrying requests
          example: redeem-item-12345
          type: string
        program_id:
          description: The program this redemption belongs to
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        quantity:
          description: Number of units to redeem (UNIT_BASED rewards only, defaults to 1)
          example: 2
          type: integer
        reward_id:
          description: The reward catalog item to redeem
          example: 550e8400-e29b-41d4-a716-446655440001
          format: uuid
          type: string
      required:
        - program_id
        - reward_id
      type: object
    handlers.RedemptionResponse:
      properties:
        amount:
          description: Total amount debited from the participant's balance (decimal string)
          example: '1000.00'
          type: string
        asset_id:
          description: The asset that was debited
          example: 550e8400-e29b-41d4-a716-446655440003
          format: uuid
          type: string
        created_at:
          description: When this redemption was created
          example: '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        description:
          description: Context for this redemption, used in journal entries
          example: 'Redeemed: Gift Card'
          type: string
        id:
          description: Unique identifier for this redemption
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        journal_entry_id:
          description: The ledger journal entry created by this redemption
          example: 550e8400-e29b-41d4-a716-446655440005
          format: uuid
          type: string
        participant_id:
          description: The participant who redeemed
          example: 550e8400-e29b-41d4-a716-446655440002
          format: uuid
          type: string
        program_id:
          description: The program this redemption belongs to
          example: 550e8400-e29b-41d4-a716-446655440001
          format: uuid
          type: string
        quantity:
          description: Number of units redeemed (catalog redemptions only)
          example: 2
          type: integer
        reversed_amount:
          description: Cumulative amount reversed so far (decimal string)
          example: '0.00'
          type: string
        reversed_quantity:
          description: >-
            Cumulative units reversed so far (UNIT_BASED catalog redemptions
            only)
          example: 0
          type: integer
        reward_id:
          description: The reward catalog item that was redeemed (catalog redemptions only)
          example: 550e8400-e29b-41d4-a716-446655440004
          format: uuid
          type: string
        status:
          description: 'Current state: COMPLETED, PARTIALLY_REVERSED, or FULLY_REVERSED'
          example: COMPLETED
          type: string
        unit_cost:
          description: >-
            Cost per unit at the time of redemption (catalog redemptions only,
            decimal string)
          example: '500.00'
          type: string
        updated_at:
          description: When this redemption was last updated (e.g., after a reversal)
          example: '2024-01-15T10:30:00Z'
          format: date-time
          type: string
      type: object
    handlers.ErrBadRequestResponse:
      additionalProperties: false
      properties:
        code:
          description: Code is the machine-readable error code
          example: bad_request
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: >-
            Details provides optional structured error context (field errors,
            etc.)
        message:
          description: Message is the human-readable error description
          example: Invalid request parameters
          type: string
      type: object
    handlers.ErrUnauthorizedResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unauthorized
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Missing or invalid credentials
          type: string
      type: object
    handlers.ErrNotFoundResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: not_found
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Resource not found
          type: string
      type: object
    handlers.ErrConflictResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: conflict
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Resource already exists or state conflict
          type: string
      type: object
    handlers.ErrUnsupportedMediaTypeResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unsupported_media_type
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Content-Type must be application/json
          type: string
      type: object
    handlers.ErrUnprocessableResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unprocessable
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Business rule violation
          type: string
      type: object
    handlers.ErrInternalResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: internal_error
          type: string
        message:
          description: Message is the human-readable error description
          example: An internal error occurred
          type: string
      type: object
    handlers.ErrorDetails:
      description: >-
        Optional structured details about the error. Always a JSON object: a
        `fields` array for validation errors, or flat
        field/reason/expected/received properties for other input errors.
      properties:
        expected:
          description: Expected value or format (non-validation input errors)
          example: uuid
          type: string
        field:
          description: Field name that caused the error (non-validation input errors)
          example: asset_id
          type: string
        fields:
          description: >-
            Fields lists each offending input field on validation_error
            responses.
          items:
            $ref: '#/components/schemas/handlers.ErrorFieldDetail'
          type: array
        reason:
          description: Machine-readable reason code (non-validation input errors)
          example: invalid
          type: string
        received:
          description: Value that was received (non-validation input errors)
          example: not-a-uuid
          type: string
      type: object
    handlers.ErrorFieldDetail:
      description: >-
        A single field-level error: which input field failed, why, and (where
        known) the expected and received values.
      properties:
        expected:
          description: >-
            Expected value or format. Usually a string; for "one of" constraints
            it

            is an array of the allowed values.
        field:
          description: Field name that caused the error
          example: amount
          type: string
        message:
          description: Human-readable explanation (validation errors only)
          example: This field is required
          type: string
        reason:
          description: Machine-readable reason code
          example: required
          type: string
        received:
          description: Value that was received
          example: '-10.00'
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: API key passed in the X-API-Key header.
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Bearer token passed in the Authorization header (e.g. "Bearer sk_...").
      in: header
      name: Authorization
      type: apiKey

````