PayPal · Schema

Error Details

The error details. Required for client-side `4XX` errors.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
field	string	The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
value	string	The value of the field that caused the error.
location	object
issue	string	The unique, fine-grained application-level error code.
description	string	The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/error_details",
  "title": "Error Details",
  "type": "object",
  "description": "The error details. Required for client-side `4XX` errors.",
  "properties": {
    "field": {
      "type": "string",
      "description": "The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors."
    },
    "value": {
      "type": "string",
      "description": "The value of the field that caused the error."
    },
    "location": {
      "$ref": "#/components/schemas/error_location"
    },
    "issue": {
      "type": "string",
      "description": "The unique, fine-grained application-level error code."
    },
    "description": {
      "type": "string",
      "description": "The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value."
    }
  },
  "required": [
    "issue"
  ]
}