If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more
Error Details
The error details. Required for client-side 4XX errors.
fieldstringOptional
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.
Match^[\S\s]*$Length0 <= length <= 2147483647
valuestringOptional
The value of the field that caused the error.
Match^[\S\s]*$Length0 <= length <= 2147483647
locationstringOptional
The location of the field that caused the error. Value is `body`, `path`, or `query`.
An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.
Items1 <= length <= 4
link_description properties
8 properties
hrefstringRequired
The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
Match^[\S\s]*$Length0 <= length <= 2147483647
relstringRequired
The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).
Match^[\S\s]*$Length0 <= length <= 2147483647
methodenumOptional
The HTTP method required to make the related call.
The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).
Match^[\S\s]*$Length0 <= length <= 2147483647
binaryEncodingstring<binary_encoding>Optional
The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).
Match^[\S\s]*$Length0 <= length <= 2147483647
pathStartstring<path_start>Optional
To apply this schema to the instances' URIs, start the URIs with this value.
The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).
Match^[\S\s]*$Length0 <= length <= 2147483647
binaryEncodingstring<binary_encoding>Optional
The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).
Match^[\S\s]*$Length0 <= length <= 2147483647
pathStartstring<path_start>Optional
To apply this schema to the instances' URIs, start the URIs with this value.
FormaturiLength0 <= length <= 2147483647
descriptionstringOptional
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.