On this page
No Headings
An array of error responses.
arrayitemsobjectThe error details.
namerequiredstringThe human-readable, unique name of the error.
messagerequiredstringThe message that describes the error.
debug_idrequiredstringThe PayPal internal ID. Used for correlation purposes.
information_linkstringThe information link, or URI, that shows detailed information about this error for the developer.
detailsarrayAn array of additional details about the error.
itemsobjectThe error details. Required for client-side 4XX errors.
fieldstringThe 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.
valuestringThe value of the field that caused the error.
locationstring"body"The location of the field that caused the error. Value is body, path, or query.
issuerequiredstringThe unique, fine-grained application-level error code.
descriptionstringThe human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.
linksarrayAn array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.