> ## 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.

# Forfeit group balance

> Moves group balance to breakage (system account).

Permanently removes balance from a group by moving it to breakage. This is irreversible.

This uses the same request body as the participant forfeit endpoint. See [forfeit participant balance](/api-reference/participants/forfeit-participant-balance) for field details.


## OpenAPI

````yaml POST /v1/groups/{id}/balances/forfeit
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/groups/{id}/balances/forfeit:
    post:
      tags:
        - Groups
      summary: Forfeit group balance
      description: Moves group balance to breakage (system account).
      operationId: forfeitGroupBalance
      parameters:
        - description: Group ID
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            Idempotency key (1-255 printable ASCII chars). Equivalent to the
            idempotency_key body field; if both are provided they must match.
            Replays with the same key and identical parameters return the
            original result; the same key with different parameters returns 409
            idempotency_conflict.
          in: header
          name: Idempotency-Key
          schema:
            maxLength: 255
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handlers.BalanceOperationRequest'
        description: Forfeit parameters
        required: true
        x-originalParamName: request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.BalanceOperationResponse'
          description: Balance forfeited
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrBadRequestResponse'
          description: >-
            Invalid parameters or invalid/mismatched Idempotency-Key header
            (code: 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: 'Group not found (code: not_found)'
        '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 funds or program not active (code: insufficient_funds |
            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.BalanceOperationRequest:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Amount to process. Omit to process the full balance (SIMPLE) or all
            matching lots (LOT)
          example: '100.00'
          type: string
        asset_id:
          description: Asset to operate on
          example: 550e8400-e29b-41d4-a716-446655440001
          format: uuid
          type: string
        bucket:
          description: >-
            Which bucket to forfeit from. Required for forfeit; ignored for
            hold/release
          enum:
            - AVAILABLE
            - HELD
          example: AVAILABLE
          type: string
        description:
          description: Reason for this operation
          example: 'Hold for pending order #123'
          maxLength: 500
          minLength: 1
          type: string
        earned_from:
          description: >-
            Only process lots earned on or after this time (RFC 3339). LOT mode
            only.
          example: '2024-01-01T00:00:00Z'
          format: date-time
          type: string
        earned_to:
          description: >-
            Only process lots earned on or before this time (RFC 3339). LOT mode
            only. Must be >= earned_from when both are provided.
          example: '2024-12-31T23:59:59Z'
          format: date-time
          type: string
        idempotency_key:
          description: >-
            Client-provided key to dedupe retries. May also be supplied via the
            Idempotency-Key HTTP header; when both are present they must match.
            Identical operations with the same key return the original result; a
            reused key with different payload returns 409 idempotency_conflict.
          example: order-123-hold
          maxLength: 255
          minLength: 1
          type: string
        lot_ids:
          description: Restrict to specific lots. LOT mode only
          example:
            - 550e8400-e29b-41d4-a716-446655440002
          items:
            type: string
          type: array
        program_id:
          description: Program this operation belongs to
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        reference_id:
          description: >-
            Correlation ID linking holds to releases. LOT mode only. Hold stamps
            lots; release filters by reference.
          example: auth_12345
          type: string
      required:
        - asset_id
        - description
        - program_id
      type: object
    handlers.BalanceOperationResponse:
      properties:
        amount_processed:
          description: Total amount processed
          example: '100.00'
          type: string
        asset_id:
          description: Asset ID
          example: 550e8400-e29b-41d4-a716-446655440001
          format: uuid
          type: string
        balance:
          allOf:
            - $ref: '#/components/schemas/handlers.BalanceSummary'
          description: Balance after the operation
        journal_entry_id:
          description: Ledger journal entry created by this operation
          example: 550e8400-e29b-41d4-a716-446655440003
          format: uuid
          type: string
        lots_processed:
          description: Individual lots affected. Only present for LOT mode assets
          items:
            $ref: '#/components/schemas/handlers.ProcessedLotResponse'
          type: array
        message:
          description: Confirmation message
          example: Processed 100.00
          type: string
        operation:
          description: Operation performed
          example: HOLD
          type: string
        program_id:
          description: Program ID
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        reference_id:
          description: Correlation ID linking this hold/release (if provided)
          example: auth_12345
          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.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.BalanceSummary:
      properties:
        available:
          description: Spendable balance
          example: '1400.00'
          type: string
        deferred:
          description: Balance not yet matured
          example: '0.00'
          type: string
        held:
          description: Balance reserved by hold operations
          example: '200.00'
          type: string
      type: object
    handlers.ProcessedLotResponse:
      properties:
        amount:
          description: Amount processed from this lot
          example: '50.00'
          type: string
        id:
          description: Lot ID
          example: 550e8400-e29b-41d4-a716-446655440002
          format: uuid
          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

````