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

# List affiliate claims

> Claims for an affiliate.

**/v1/affiliates/\{affiliateId}/claims**


## OpenAPI

````yaml https://orchestration.flashnet.xyz/openapi.json GET /v1/affiliates/{affiliateId}/claims
openapi: 3.1.0
info:
  title: Flashnet Orchestrator API
  version: 0.1.0
  description: >-
    Partner API for quotes, orders, standing deposits, webhooks, and affiliates.
    Operations marked x-excluded are omitted from the documentation navigation;
    internal, pay-link, SSE, and provider-integration routes are outside this
    registry.
servers:
  - url: https://orchestration.flashnet.xyz
security: []
tags:
  - name: Orchestration
    description: >-
      Routes, limits, estimates, quotes, orders, onramp, and ZeroConf decisions
      for one-off swaps.
  - name: Standing Deposit Addresses
    description: >-
      Permanent per-customer deposit addresses bound to one immutable conversion
      instruction.
  - name: Webhooks
    description: >-
      Registration of HTTPS endpoints for order status events and recovery
      events.
  - name: Affiliates
    description: Registered fee recipients, their accrued balances, and claims.
  - name: Accumulation Addresses
    description: >-
      Legacy reusable addresses that convert one source asset into Spark BTC or
      USDB.
  - name: Liquidations
    description: >-
      Legacy Bitcoin L1 deposit addresses that convert each output to a
      configured destination.
  - name: System
  - name: Explorer
  - name: Dashboard
  - name: Affiliate Dashboard
paths:
  /v1/affiliates/{affiliateId}/claims:
    get:
      tags:
        - Affiliates
      summary: List affiliate claims
      description: Claims for an affiliate.
      operationId: getV1AffiliatesAffiliateIdClaims
      parameters:
        - schema:
            type: string
            minLength: 1
          required: true
          name: affiliateId
          in: path
        - schema:
            type: string
            minLength: 1
          required: false
          name: settlementChain
          in: query
        - schema:
            type: string
            minLength: 1
          required: false
          name: settlementAsset
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            minimum: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: Claim list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliateClaimListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    AffiliateClaimListResponse:
      type: object
      properties:
        claims:
          type: array
          items:
            $ref: '#/components/schemas/AffiliateClaim'
        nextOffset:
          type:
            - integer
            - 'null'
      required:
        - claims
        - nextOffset
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      additionalProperties: false
    AffiliateClaim:
      type: object
      properties:
        id:
          type: string
        affiliateId:
          type: string
        amount:
          type: string
        settlementChain:
          type: string
        settlementAsset:
          type: string
        payoutChain:
          $ref: '#/components/schemas/Chain'
        payoutAsset:
          type: string
        payoutAddress:
          type: string
        status:
          type: string
          enum:
            - processing
            - completed
            - failed
        txHash:
          type:
            - string
            - 'null'
        relayRequestId:
          type:
            - string
            - 'null'
        operationId:
          type:
            - string
            - 'null'
        errorMessage:
          type:
            - string
            - 'null'
        nextAttemptAt:
          type: string
        attempts:
          type: integer
        createdAt:
          type: string
        completedAt:
          type:
            - string
            - 'null'
      required:
        - id
        - affiliateId
        - amount
        - settlementChain
        - settlementAsset
        - payoutChain
        - payoutAsset
        - payoutAddress
        - status
        - txHash
        - relayRequestId
        - operationId
        - errorMessage
        - nextAttemptAt
        - attempts
        - createdAt
        - completedAt
      additionalProperties: false
    ErrorDetail:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      additionalProperties: false
    Chain:
      type: string
      enum:
        - arbitrum
        - arc
        - avalanche
        - base
        - bitcoin
        - bsc
        - ethereum
        - hedera
        - hypercore
        - hyperevm
        - lightning
        - litecoin
        - monad
        - monero
        - optimism
        - plasma
        - polygon
        - robinhood
        - sei
        - solana
        - spark
        - tempo
        - ton
        - tron
        - xrp
        - zcash
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Partner API key in the form `Authorization: Bearer fn_...`.'

````

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