PayPal · Schema

Payout Batch

The PayPal-generated batch status.

BillingCommerceDisputesInvoicesOrderPaymentsPayoutsSubscriptionTokensWebhook

Properties

Name Type Description
total_items integer The total number of items in the full result list.
total_pages integer The total number of pages.
batch_header object A payout header. Includes the generated payout status.
items array An array of individual items.
links array An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links).
View JSON Schema on GitHub

JSON Schema

paypal-payout-batch-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payout_batch",
  "title": "Payout Batch",
  "type": "object",
  "description": "The PayPal-generated batch status.",
  "properties": {
    "total_items": {
      "description": "The total number of items in the full result list.",
      "type": "integer",
      "minimum": 0,
      "maximum": 15000
    },
    "total_pages": {
      "description": "The total number of pages.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000
    },
    "batch_header": {
      "description": "A payout header. Includes the generated payout status.",
      "$ref": "#/components/schemas/payout_batch_header"
    },
    "items": {
      "type": "array",
      "description": "An array of individual items.",
      "items": {
        "$ref": "#/components/schemas/payout_batch_items"
      },
      "minItems": 0,
      "maxItems": 15000
    },
    "links": {
      "type": "array",
      "description": "An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links).",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/link_description"
      },
      "minItems": 0,
      "maxItems": 15000
    }
  }
}

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/paypal-payout-batch"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.