PayPal · Schema

Payout Item

The payout item status and other details. A payout_item_id helps you identify denied payments. If a payment is denied, you can use the payout_item_id to identify the payment even if it lacks a transaction_id.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
payout_item_id	string	The ID for the payout item. Visible when you show details for a payout.
transaction_id	string	The PayPal-generated ID for the transaction.
activity_id	string	The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking.
transaction_status	object
payout_item_fee	object	The estimate for the payout fee. Initially, the fee is `0`. The fee is populated after the item moves to the `PENDING` state
payout_batch_id	string	The PayPal-generated ID for the payout batch.
sender_batch_id	string	A sender-specified ID. Tracks the payout in an accounting system. Should be unique within 30 days.
payout_item	object	The sender-provided information for the payout item.
currency_conversion	object	The currency conversion applicable for this payout item.
time_processed	string	The date and time when this item was last processed, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
errors	object	The error details.
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_item-2",
  "title": "Payout Item",
  "type": "object",
  "description": "The payout item status and other details. A <code>payout_item_id</code> helps you identify denied payments. If a payment is denied, you can use the <code>payout_item_id</code> to identify the payment even if it lacks a <code>transaction_id</code>.",
  "properties": {
    "payout_item_id": {
      "type": "string",
      "description": "The ID for the payout item. Visible when you show details for a payout.",
      "minLength": 0,
      "maxLength": 30,
      "pattern": "^.*$"
    },
    "transaction_id": {
      "type": "string",
      "description": "The PayPal-generated ID for the transaction.",
      "minLength": 0,
      "maxLength": 30,
      "pattern": "^.*$"
    },
    "activity_id": {
      "type": "string",
      "description": "The unique PayPal-generated common ID that links the sender- and receiver-side transactions. Used for tracking.",
      "minLength": 0,
      "maxLength": 30,
      "pattern": "^.*$"
    },
    "transaction_status": {
      "$ref": "#/components/schemas/transaction_enum"
    },
    "payout_item_fee": {
      "description": "The estimate for the payout fee. Initially, the fee is `0`. The fee is populated after the item moves to the `PENDING` state",
      "$ref": "#/components/schemas/currency"
    },
    "payout_batch_id": {
      "type": "string",
      "description": "The PayPal-generated ID for the payout batch.",
      "minLength": 0,
      "maxLength": 30,
      "pattern": "^.*$"
    },
    "sender_batch_id": {
      "type": "string",
      "description": "A sender-specified ID. Tracks the payout in an accounting system. Should be unique within 30 days.",
      "minLength": 0,
      "maxLength": 256,
      "pattern": "^.*$"
    },
    "payout_item": {
      "description": "The sender-provided information for the payout item.",
      "$ref": "#/components/schemas/payout_item_detail"
    },
    "currency_conversion": {
      "description": "The currency conversion applicable for this payout item.",
      "$ref": "#/components/schemas/payout_currency_conversion"
    },
    "time_processed": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when this item was last processed, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
      "minLength": 1,
      "maxLength": 100
    },
    "errors": {
      "$ref": "#/components/schemas/error",
      "description": "The error details."
    },
    "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
    }
  },
  "required": [
    "payout_item_id",
    "payout_batch_id",
    "payout_item"
  ]
}