find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/affiliaterail-com:affiliaterail-com-payouts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Affiliaterail Com Payouts API
  version: '2026-08-21'
  description: 'Operations tagged Payouts across 2 of this provider''s published API definitions: affiliaterail-com-docs-openapi.json, affiliaterail-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.affiliaterail.com
  description: Production
tags:
- name: Payouts
paths:
  /v1/payouts:
    get:
      tags:
      - Payouts
      summary: List payouts
      description: '`not_eligible` payouts carry the reason in words. Nothing is dropped silently.


        **Scope:** `read`'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          example: prg_7uSyy9FqVLCFWrdPeZaK
          description: Required on every list
        required: true
        description: Required on every list
        name: program_id
        in: query
      - schema:
          type: string
          example: '25'
          description: 1 to 100, default 25
        required: false
        description: 1 to 100, default 25
        name: limit
        in: query
      - schema:
          type: string
          description: Object id; returns the page after it (older)
        required: false
        description: Object id; returns the page after it (older)
        name: starting_after
        in: query
      - schema:
          type: string
          description: Object id; returns the page before it (newer)
        required: false
        description: Object id; returns the page before it (newer)
        name: ending_before
        in: query
      - schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
          description: 'Relations to embed: partner, batch'
        required: false
        description: 'Relations to embed: partner, batch'
        name: expand[]
        in: query
      - schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
          description: Nothing to include on this resource
        required: false
        description: Nothing to include on this resource
        name: include[]
        in: query
      - schema:
          type: string
        required: false
        name: partner_id
        in: query
      - schema:
          type: string
        required: false
        name: batch_id
        in: query
      - schema:
          type: string
          enum:
          - not_eligible
          - pending
          - processing
          - paid
          - failed
        required: false
        name: status
        in: query
      responses:
        '200':
          description: Payouts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutList'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV1Payouts
      x-operation-id-source: derived
    servers:
    - url: https://api.affiliaterail.com
      description: Production
  /v1/payouts/{id}:
    get:
      tags:
      - Payouts
      summary: Retrieve a payout
      description: '**Scope:** `read`'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          pattern: ^(sample_)?pyt_
          example: pyt_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`pyt_…`)
        required: true
        description: Prefixed id (`pyt_…`)
        name: id
        in: path
      - schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
          description: 'Relations to embed: partner, batch'
        required: false
        description: 'Relations to embed: partner, batch'
        name: expand[]
        in: query
      - schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
          description: Nothing to include on this resource
        required: false
        description: Nothing to include on this resource
        name: include[]
        in: query
      responses:
        '200':
          description: The payout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV1PayoutsById
      x-operation-id-source: derived
    servers:
    - url: https://api.affiliaterail.com
      description: Production
  /v1/payouts/{id}/mark_paid:
    post:
      tags:
      - Payouts
      summary: Mark a payout paid
      description: 'You paid it yourself, outside PayPal or Wise. Moves the commissions to `paid` and the money from due to paid. Allowed from `pending` and `failed`; never while a rail has it in flight, never twice.


        **Scope:** `payouts:write` (or `write`)'
      security:
      - bearerAuth: []
      parameters:
      - schema:
          type: string
          pattern: ^(sample_)?pyt_
          example: pyt_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`pyt_…`)
        required: true
        description: Prefixed id (`pyt_…`)
        name: id
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoutMarkPaid'
      responses:
        '200':
          description: The payout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such object in your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The request was understood and refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Rate limited: see Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: postV1PayoutsByIdMarkPaid
      x-operation-id-source: derived
    servers:
    - url: https://api.affiliaterail.com
      description: Production
components:
  schemas:
    PayoutList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Payout'
        has_more:
          type: boolean
          description: Pass the last object's id as `starting_after` to fetch the next page
        total_count:
          type: integer
          description: Count of every object matching the filters, ignoring the cursor
      required:
      - data
      - has_more
      - total_count
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - authentication_error
              - permission_error
              - invalid_request_error
              - not_found_error
              - conflict_error
              - rate_limit_error
              - plan_error
              - not_implemented_error
              - api_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
          required:
          - type
          - code
          - message
      required:
      - error
    PayoutMarkPaid:
      type: object
      properties:
        paid_at:
          type: string
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        external_id:
          type: string
          description: Your reference from the payout method you paid through
    Payout:
      type: object
      properties:
        id:
          type: string
          pattern: ^(sample_)?pyt_
          example: pyt_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`pyt_…`)
        object:
          type: string
          enum:
          - payout
        program_id:
          type: string
          pattern: ^(sample_)?prg_
          example: prg_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`prg_…`)
        partner_id:
          type: string
          pattern: ^(sample_)?part_
          example: part_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`part_…`)
        batch_id:
          type:
          - string
          - 'null'
          pattern: ^(sample_)?batch_
          example: batch_7uSyy9FqVLCFWrdPeZaK
          description: Prefixed id (`batch_…`)
        amount_minor:
          type: integer
          example: 2500
          description: Integer minor units (cents, pence). Never a float, never a string.
        currency:
          type: string
          minLength: 3
          maxLength: 3
          example: USD
          description: ISO-4217
        method:
          type:
          - string
          - 'null'
          enum:
          - paypal
          - wise
          - bank_transfer
          - wire
          - crypto
          - payoneer
          - null
        status:
          type: string
          enum:
          - not_eligible
          - pending
          - processing
          - paid
          - failed
        not_eligible_reason:
          type:
          - string
          - 'null'
          description: Why this partner was not paid this period, in words
        external_id:
          type:
          - string
          - 'null'
        error_code:
          type:
          - string
          - 'null'
        error_message:
          type:
          - string
          - 'null'
        period_start:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        period_end:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        paid_at:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        metadata:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Your own key/value data, stored as given
        created_at:
          type: string
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
        updated_at:
          type: string
          format: date-time
          example: '2026-08-21T10:15:30.000Z'
          description: ISO-8601, UTC
      required:
      - id
      - object
      - program_id
      - partner_id
      - batch_id
      - amount_minor
      - currency
      - method
      - status
      - not_eligible_reason
      - external_id
      - error_code
      - error_message
      - period_start
      - period_end
      - paid_at
      - metadata
      - created_at
      - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rail_live_… or rail_test_…
      description: Create keys in Settings → API keys. Each key carries scopes; the docs name the scope every route needs.
x-refined-from:
- affiliaterail-com-docs-openapi.json
- affiliaterail-com-openapi.json