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

# Reject Reward

> Rejects a `pending` reward so it will not be paid out to the advocate. Use this when a reward should not have been earned, for example because the lead turned out to be a duplicate or a self-referral. You can optionally pass a `reject_reason`, which is stored on the reward and returned in the `reject_reason` attribute while the reward is rejected. Only `pending` rewards can be rejected; `paid` rewards cannot be reverted through the API. A rejected reward can be moved back to `pending` with the unreject endpoint.



## OpenAPI

````yaml POST /v1/rewards/{id}/reject
openapi: 3.1.0
info:
  title: Reditus API - Rewards
  description: API specification for managing rewards in Reditus reward programs.
  version: 1.0.0
servers:
  - url: https://api.getreditus.com/api
security: []
paths:
  /v1/rewards/{id}/reject:
    post:
      summary: Reject Reward
      description: >-
        Rejects a `pending` reward so it will not be paid out to the advocate.
        Use this when a reward should not have been earned, for example because
        the lead turned out to be a duplicate or a self-referral. You can
        optionally pass a `reject_reason`, which is stored on the reward and
        returned in the `reject_reason` attribute while the reward is rejected.
        Only `pending` rewards can be rejected; `paid` rewards cannot be
        reverted through the API. A rejected reward can be moved back to
        `pending` with the unreject endpoint.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Reward ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RejectRewardRequest'
      responses:
        '200':
          description: Reward was rejected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RewardResponse'
        '404':
          description: Not Found - Reward not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorRewardNotFoundError'
        '422':
          description: >-
            Unprocessable - Reward cannot be rejected from its current state (it
            is already rejected, or has been paid)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseUnprocessable'
      security:
        - BearerAuth: []
components:
  schemas:
    RejectRewardRequest:
      type: object
      properties:
        reject_reason:
          type: string
          description: >-
            Optional free-text reason for rejecting the reward. Shown to your
            team in the Reditus dashboard and returned in the reward's
            `reject_reason` attribute.
          example: Duplicate signup
    RewardResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Reward'
    ErrorRewardNotFoundError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              details:
                type: string
                example: Reward not found
    ErrorResponseUnprocessable:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
                example: Unprocessable entity
              details:
                type: string
                example: Reward in state 'paid' cannot be rejected
    Reward:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
            advocate_id:
              type: string
            advocate_uid:
              type: string
            lead_id:
              type: string
            lead_email:
              type: string
            amount:
              type: integer
              description: Amount in cents (e.g., 1000 = $10.00)
            currency:
              type: string
            state:
              type: string
              description: 'Reward state: pending, rejected or paid'
            reject_reason:
              type: string
              description: >-
                Reason the reward was rejected. Only present when state is
                rejected
            created_at:
              type: integer
            updated_at:
              type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.