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

# Candidate payouts for a redemption

> Unmatched payouts to the same address, or any address at the exact amount. all_unmatched=true returns every unmatched payout.



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/redemptions/{id}/candidates
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.31
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/redemptions/{id}/candidates:
    get:
      tags:
        - Redemptions
      summary: Candidate payouts for a redemption
      description: >-
        Unmatched payouts to the same address, or any address at the exact
        amount. all_unmatched=true returns every unmatched payout.
      operationId: candidates
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: all_unmatched
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CandidatesResponseDto'
components:
  schemas:
    CandidatesResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CandidatePayoutDto'
      required:
        - items
    CandidatePayoutDto:
      type: object
      properties:
        payout_id:
          type: string
        amount:
          type: string
        redeeming_address:
          type: string
        payout_date:
          type: string
        payout_reference:
          type: string
          nullable: true
        source_ref:
          type: string
          nullable: true
        reason:
          type: string
          enum:
            - same_address
            - exact_amount
        difference:
          type: string
      required:
        - payout_id
        - amount
        - redeeming_address
        - payout_date
        - difference
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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