PayPal · Schema

Payout Batch

The PayPal-generated batch status.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

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

{
  "$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
    }
  }
}