Orders v2 errors
Errors are listed by endpoint and then by error name.
Get order
Error
Description
Issue
An internal server error occurred. A system or application error occurred.
Authorization failed due to insufficient permissions.
/purchase_units
/purchase_units/0/shipping/options
/purchase_units
payer/address/country_code
purchase_units/0/shipping/address/country_code
payment_source/card/billing_address/country_code
payment_source/ideal/country_code
application_context/locale
payer/address/country_code
payer/birth_date
payer/email_address
payer/payer_id
payer/phone/*
purchase_units/*
application_context/brand_name
application_context/locale
payer/*
purchase_units/0/*
payment_source/token/id
payment_source/card/billing_address/country_code
application_context/landing_page
application_context/locale
application_context/shipping_preference
application_context/user_action
intent
payer/phone/phone_type
payer/tax_info/tax_id_type
prefer
purchase_units/0/items/0/category
payment_source/token/type
intent
purchase_units
purchase_units/0/amount
purchase_units/0/amount/value
purchase_units/0/amount/currency_code
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
/purchase_units/0/shipping/options/0/selected
payment_source/token/id
payment_source/token/type
payment_source/card/expiry
payer/address/*
payer/name/*
payer/phone/phone_number/*
purchase_units/0/shipping/address/*
purchase_units/0/shipping/name/*
PayPal-Request-Id
is required if you are trying to process payment for an Order. Please specify a PayPal-Request-Id or Create the Order without a
payment_source
specified.
items.category
as
DONATION
. Speak to your account manager if you want to process these type of items.
UNPROCESSABLE_ENTITY
The requested action could not be completed, was semantically incorrect, or failed business validation.
item_total
+
tax_total
+
shipping
+
handling
+
insurance
-
shipping_discount
-
discount
.
address.admin_area_2
.
reference_id
must be unique if multiple
purchase_unit
are provided.
unit_amount
*
quantity
across all items for a given
purchase_unit
.
items.unit_amount
and
items.quantity
and
amount.breakdown.item_total
are required.
9999999.99
.
shipping.address
) is required for the provided
shipping.type
. Possible error location:
/purchase_units/0/shipping/type
currency_code
are not supported. Entire order request must have the same currency code.
items.category
could be either
PHYSICAL_GOODS
and\/or
DIGITAL_GOODS
or just
DONATION
.
items.category
as
DONATION
cannot be combined with items with either
PHYSICAL_GOODS
or
DIGITAL_GOODS
.
shipping.type
are not supported across purchase units.
payeeId
and
payeeEmail
.
tax
*
quantity
across all items for a given purchase unit.
items.tax_total
,
items.quantity
, and
amount.breakdown.tax_total
are required.
intent=AUTHORIZE
is not supported for multiple purchase units. Only
intent=CAPTURE
is supported.
intent=AUTHORIZE
. For details, see
Capture authorization
. For
intent=CAPTURE
, send the payment instruction when you create the order.
shipping.type=PICKUP_IN_PERSON
. This feature is only supported for
PayPal Complete Payments Platform for Platforms and Marketplaces
.
shipping.type
is only supported for
application_context.shipping_preference=SET_PROVIDED_ADDRESS
or
NO_SHIPPING
. Possible error location:
/purchase_units/0/shipping/type
.
selected = true
.
application_context.shipping_preference
is set to
NO_SHIPPING
or
SET_PROVIDED_ADDRESS
.
shipping.option
can be set to
selected = true
.
/purchase_units/0/shipping/options/0/amount/value
.
new_fx_id
link to retrieve a new FX rate ID and try the request again.
INVALID_ACCOUNT_STATUS
: Account validations failed for the user.
status
/purchase_units/0/shipping/options
.
/purchase_units/0/payee/email_address
.
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
op
.
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
/purchase_units/0/shipping/options/0/selected
/purchase_units/0/amount
op
.
INVALID_JSON_POINTER_FORMAT
: Path should be a valid
JSON Pointer
that references a location within the request where the operation is performed.
INVALID_PARAMETER
: Cannot be specified as part of the request.
NOT_PATCHABLE
: Cannot be patched.
UNSUPPORTED_PATCH_PARAMETER_VALUE
: The value specified for this field is not currently supported.
PATCH_VALUE_REQUIRED
: Specify a
value
for the field being patched.
PATCH_PATH_REQUIRED
: Specify a
value
for the field in which the operation needs to be performed.
REFERENCE_ID_NOT_FOUND
: Filter expression value is incorrect. Check the value of the
reference_id
and try again.
MULTI_CURRENCY_ORDER
: Multiple differing values of
currency_code
are not supported. Entire order request must have the same currency code.
SHIPPING_OPTION_NOT_SELECTED
: At least one of the
shipping.option
should be set to
selected = true
.
MULTI_CURRENCY_ORDER
: Multiple differing values of
currency_code
are not supported. Entire order request must have the same currency code.
SHIPPING_OPTION_NOT_SELECTED
: At least one of the
shipping.option
should be set to
selected = true
.
SHIPPING_OPTIONS_NOT_SUPPORTED
: Shipping options are not supported when
application_context.shipping_preference
is set to
or
.
ORDER_ALREADY_COMPLETED
: The order cannot be patched after it is completed.
PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH
: The amount provided in the preferred shipping option should match the amount provided in amount breakdown. Possible error location:
/purchase_units/0/shipping/options/0/amount/value
.
FX_RATE_CHANGE_DUE_TO_MARKET_EVENT
: The foreign exchange rate (FX) rate associated with the specified FX rate ID has been changed due to market events. Please refer to the provided
new_fx_id
link to retrieve a new FX rate ID and try the request again.
Authorize order
Error
Description
Issue
An internal server error occurred. A system or application error occurred.
Authentication failed due to missing authorization header or invalid authentication credentials.
: Account validations failed for the user.
"Request is not well formed, is syntactically incorrect, or violates schema.
payment_source/card/billing_address/country_code
.
INVALID_PARAMETER_VALUE
: A parameter value is not valid. Possible error locations:
payment_source/token/type
payment_source/token/id
payment_source/token/type
payment_source/card/expiry
payment_source/token/id
payment_source/card/billing_address/country_code
/payment_source/paypal/attributes/customer/id
items.category
as
DONATION
. Speak to your account manager if you want to process these type of items.
UNPROCESSABLE_ENTITY
"The requested action could not be performed, is semantically incorrect, or failed business validation.
ACTION_DOES_NOT_MATCH_INTENT
: Order was created with an intent to
CAPTURE
. Use
v2/checkout/orders/order_id/capture
to complete the transaction or alternately Create an order with an intent of
AUTHORIZE
.
AGREEMENT_ALREADY_CANCELLED
: The requested agreement is already canceled.