PayPal · Schema

Capture Status

The status of a captured payment.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
status string The status of the captured payment.
status_details object The details of the captured payment status.
View JSON Schema on GitHub

JSON Schema

paypal-capture-status-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/capture_status",
  "title": "Capture Status",
  "type": "object",
  "description": "The status of a captured payment.",
  "properties": {
    "status": {
      "description": "The status of the captured payment.",
      "type": "string",
      "readOnly": true,
      "enum": [
        "COMPLETED",
        "DECLINED",
        "PARTIALLY_REFUNDED",
        "PENDING",
        "REFUNDED"
      ]
    },
    "status_details": {
      "description": "The details of the captured payment status.",
      "readOnly": true,
      "$ref": "#/components/schemas/capture_status_details"
    }
  }
}