PayPal · Schema

Payment Collection

The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
authorizations	array	An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.
captures	array	An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.
refunds	array	An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/payment_collection",
  "title": "Payment Collection",
  "type": "object",
  "description": "The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.",
  "properties": {
    "authorizations": {
      "type": "array",
      "description": "An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.",
      "items": {
        "description": "The authorized payment for a purchase unit.",
        "$ref": "#/components/schemas/authorization_with_additional_data"
      }
    },
    "captures": {
      "type": "array",
      "description": "An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.",
      "items": {
        "description": "The captured payment for a purchase unit.",
        "$ref": "#/components/schemas/capture"
      }
    },
    "refunds": {
      "type": "array",
      "description": "An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.",
      "items": {
        "description": "A refund for a purchase unit.",
        "$ref": "#/components/schemas/refund"
      }
    }
  }
}