PayPal · Schema

Capture

A captured payment.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks
View JSON Schema on GitHub

JSON Schema

paypal-capture-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/capture",
  "title": "Capture",
  "type": "object",
  "description": "A captured payment.",
  "allOf": [
    {
      "$ref": "#/components/schemas/capture_status"
    },
    {
      "properties": {
        "id": {
          "description": "The PayPal-generated ID for the captured payment.",
          "type": "string",
          "readOnly": true
        },
        "amount": {
          "description": "The amount for this captured payment.",
          "$ref": "#/components/schemas/money",
          "readOnly": true
        },
        "invoice_id": {
          "description": "The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.",
          "type": "string",
          "readOnly": true
        },
        "custom_id": {
          "type": "string",
          "description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
          "maxLength": 127
        },
        "network_transaction_reference": {
          "$ref": "#/components/schemas/network_transaction_reference"
        },
        "seller_protection": {
          "$ref": "#/components/schemas/seller_protection",
          "readOnly": true
        },
        "final_capture": {
          "description": "Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.",
          "type": "boolean",
          "default": false,
          "readOnly": true
        },
        "seller_receivable_breakdown": {
          "$ref": "#/components/schemas/seller_receivable_breakdown",
          "readOnly": true
        },
        "disbursement_mode": {
          "$ref": "#/components/schemas/disbursement_mode"
        },
        "links": {
          "description": "An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/components/schemas/link_description"
          }
        },
        "processor_response": {
          "description": "An object that provides additional processor information for a direct credit card transaction.",
          "$ref": "#/components/schemas/processor_response"
        }
      }
    },
    {
      "$ref": "#/components/schemas/activity_timestamps"
    }
  ]
}