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

# List Affiliate Payouts

> Returns the affiliate's payouts from the project — both the monthly `performance` payouts their codes earn and the `custom` ones the project created — latest period first. Note 1: this endpoint is only accessible with a secret API key. Note 2: up to 100 payouts are returned per request; page through the rest with `offset`.



## OpenAPI

````yaml get /affiliates/{affiliate_id}/payouts
openapi: 3.0.0
info:
  title: WinWinKit API
  description: An API for interacting with WinWinKit.
  version: '1.0'
  contact:
    name: WinWinKit
    url: https://winwinkit.com
    email: support@winwinkit.com
servers:
  - url: https://api.winwinkit.com
    description: Production
security: []
tags:
  - name: Users
    description: User endpoints
  - name: Claim Actions
    description: Claim actions endpoints
  - name: Rewards Actions
    description: Rewards actions endpoints
  - name: Analytics
    description: Analytics endpoints
  - name: Affiliates
    description: Affiliates endpoints
paths:
  /affiliates/{affiliate_id}/payouts:
    get:
      tags:
        - Affiliates
      summary: List Affiliate Payouts
      description: >-
        Returns the affiliate's payouts from the project — both the monthly
        `performance` payouts their codes earn and the `custom` ones the project
        created — latest period first. Note 1: this endpoint is only accessible
        with a secret API key. Note 2: up to 100 payouts are returned per
        request; page through the rest with `offset`.
      operationId: getAffiliatePayouts
      parameters:
        - name: affiliate_id
          required: true
          in: path
          description: The id of the affiliate whose payouts to list.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: How many payouts to return, from 1 to 100.
          schema:
            minimum: 1
            maximum: 100
            default: 100
            example: 100
            type: number
        - name: offset
          required: false
          in: query
          description: How many payouts to skip before the page.
          schema:
            minimum: 0
            default: 0
            example: 0
            type: number
        - name: x-api-key
          in: header
          description: The secret API key.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The page of payouts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AffiliatePayoutListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsResponse'
        '404':
          description: The affiliate is not on the project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsResponse'
        '422':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsResponse'
        '429':
          description: The rate limit for this endpoint has been exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorsResponse'
components:
  schemas:
    AffiliatePayoutListResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AffiliatePayoutList'
      required:
        - data
    ErrorsResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorObject'
      description: Errors Response
      required:
        - errors
    AffiliatePayoutList:
      type: object
      properties:
        payouts:
          description: >-
            The page of payouts: latest period first, and the newest first
            within one
          type: array
          items:
            $ref: '#/components/schemas/AffiliatePayout'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - payouts
        - pagination
    ErrorObject:
      type: object
      properties:
        code:
          type: string
        status:
          type: integer
        message:
          type: string
        source:
          type: string
          nullable: true
      description: Error Object
      required:
        - code
        - status
        - message
        - source
    AffiliatePayout:
      type: object
      properties:
        id:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          description: The payout id
        affiliate_id:
          type: string
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: The id of the affiliate the payout is to
        type:
          type: string
          enum:
            - performance
            - custom
          example: custom
          description: >-
            What the payout is: `performance` collects what the affiliate earned
            in a calendar month; `custom` is an amount the project set itself
        status:
          type: string
          enum:
            - upcoming
            - holding
            - pending
            - processing
            - sent
            - completed
            - failed
            - cancelled
          example: pending
          description: >-
            Where the payout is: `upcoming` and `holding` still collect or wait
            out refunds, `pending` is ready to be sent, `processing` is on its
            way, `completed` has been paid, `failed` goes back to pending,
            `cancelled` will not be paid
        amount:
          type: integer
          example: 25000
          description: The amount, in USD cents
        description:
          type: string
          nullable: true
          example: Launch campaign video
          description: >-
            What a `custom` payout is for, as the project put it. Null for
            `performance` payouts
        period_start:
          type: string
          format: date
          example: '2026-09-01'
          description: The first day the payout covers, in UTC
        period_end:
          type: string
          format: date
          nullable: true
          example: '2026-09-15'
          description: >-
            The last day the payout covers, in UTC. Null while an `upcoming`
            payout is still collecting
        created_at:
          type: string
          format: date-time
          example: '2026-09-29T10:15:00.000Z'
          description: When the payout was created
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: null
          description: When the payout was paid. Null until it is
      required:
        - id
        - affiliate_id
        - type
        - status
        - amount
        - description
        - period_start
        - period_end
        - created_at
        - completed_at
    Pagination:
      type: object
      properties:
        limit:
          type: number
          example: 100
          description: How many results were requested
        offset:
          type: number
          example: 0
          description: How many results were skipped before this page
        total:
          type: number
          example: 512
          description: How many results matched in total, across every page
        has_more:
          type: boolean
          example: true
          description: Whether another page follows this one
      required:
        - limit
        - offset
        - total
        - has_more

````