AffiliateRail · Schema

Payout

AffiliatesSoftware-as-a-ServiceMarketingPaymentsAffiliateSoftwareCompany

Properties

Name Type Description
id string Prefixed id (`pyt_…`)
object string
program_id string Prefixed id (`prg_…`)
partner_id string Prefixed id (`part_…`)
batch_id stringnull Prefixed id (`batch_…`)
amount_minor integer Integer minor units (cents, pence). Never a float, never a string.
currency string ISO-4217
method stringnull
status string
not_eligible_reason stringnull Why this partner was not paid this period, in words
external_id stringnull
error_code stringnull
error_message stringnull
period_start stringnull ISO-8601, UTC
period_end stringnull ISO-8601, UTC
paid_at stringnull ISO-8601, UTC
metadata objectnull Your own key/value data, stored as given
created_at string ISO-8601, UTC
updated_at string ISO-8601, UTC
View JSON Schema on GitHub

JSON Schema

affiliaterail-com-payout-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/affiliaterail-com/json-schema/affiliaterail-com-payout-schema.json",
  "title": "Payout",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/affiliaterail-com-openapi.json#/components/schemas/Payout",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(sample_)?pyt_",
      "description": "Prefixed id (`pyt_…`)"
    },
    "object": {
      "type": "string",
      "enum": [
        "payout"
      ]
    },
    "program_id": {
      "type": "string",
      "pattern": "^(sample_)?prg_",
      "description": "Prefixed id (`prg_…`)"
    },
    "partner_id": {
      "type": "string",
      "pattern": "^(sample_)?part_",
      "description": "Prefixed id (`part_…`)"
    },
    "batch_id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(sample_)?batch_",
      "description": "Prefixed id (`batch_…`)"
    },
    "amount_minor": {
      "type": "integer",
      "description": "Integer minor units (cents, pence). Never a float, never a string."
    },
    "currency": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3,
      "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",
      "description": "ISO-8601, UTC"
    },
    "period_end": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "ISO-8601, UTC"
    },
    "paid_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "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",
      "description": "ISO-8601, UTC"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "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"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/affiliaterail-com-payout"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

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