On this page
No Headings
The default error response.
Option 1objectRequest is not well-formed, syntactically incorrect, or violates schema.
namestring"INVALID_REQUEST"messagestring"Request is not well-formed, syntactically incorrect, or violates schema."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 2objectAuthentication failed due to missing Authorization header, or invalid authentication credentials.
namestring"AUTHENTICATION_FAILURE"messagestring"Authentication failed due to missing authorization header, or invalid authentication credentials."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 3objectThe client is not authorized to access this resource, although it may have valid credentials.
namestring"NOT_AUTHORIZED"messagestring"Authorization failed due to insufficient permissions."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 4objectThe server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.
namestring"RESOURCE_NOT_FOUND"messagestring"The specified resource does not exist."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 5objectThe server has detected a conflict while processing this request.
namestring"RESOURCE_CONFLICT"messagestring"The server has detected a conflict while processing this request."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 6objectThe server does not support the request payload's media type.
namestring"UNSUPPORTED_MEDIA_TYPE"messagestring"The server does not support the request payload's media type."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 7objectThe requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 response in that there are no systemic problems limiting the API from performing the request.
namestring"UNPROCESSABLE_ENTITY"messagestring"The requested action could not be performed, semantically incorrect, or failed business validation."detailsarrayitemsobjectThe 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", "path", "query""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.
debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 8objectThis is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has gone wrong on the server.
namestring"INTERNAL_SERVER_ERROR"messagestring"An internal server error occurred."debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.
Option 9objectThe server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.
namestring"SERVICE_UNAVAILABLE"messagestring"Service Unavailable."debug_idstringThe PayPal internal ID. Used for correlation purposes.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The 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.
relrequiredstring^.*$The 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", "PATCH"^[A-Z]*$The HTTP method required to make the related call.