REST APIs
    Get Started with PayPal REST APIs
    Authentication
    Postman Guide
    API requests
    API responses
    Core Resources
    Overview
    API Integration
    Release Notes
    Add Tracking
    Catalog Products
    Disputes
    Identity
    Invoicing
    Orders
      Orders
      post
      Create order
      get
      Show order details
      patch
      Update order
      post
      Confirm the Order
      post
      Authorize payment for order
      post
      Capture payment for order
      post
      Add tracking information for an Order.
      patch
      Update or cancel tracking information for an order
      post
      Receive updated order information via callback URL
      Definitions
      Address Requirements
      Error Messages
    Partner Referrals
    Payment Experience
    Payment Method Tokens
    Payments
    Payouts
    Referenced Payouts
    Subscriptions
    Transaction Search
    Webhooks Management
    Webhooks
    Overview
    Webhook event names
    Webhooks Events dashboard
    Webhooks simulator
    Integration
    Sandbox
    Overview
    Accounts
    Bulk Accounts
    Card testing
    Codespaces
    PayPal for Visual Studio Code
    Negative Testing
    Go Live
    Production Environment
    PayPal Application Guidelines
    PayPal Security Guidelines
    Rate Limiting Guidelines
    Idempotency
    Troubleshooting
    Not authorized
    Resource not found
    Unprocessable entity
    Validation error
    Reference
    Currency Codes
    Country Codes
    State & Province Codes
    Locale codes
    Deprecated Resources
    Deprecated resources
    Billing Agreements
    Billing Plans
    Invoicing v1
    Orders v1
    Partner Referrals v1
    Payments v1

Orders v2 errors

Errors are listed by endpoint and then by error name.

Get order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
RESOURCE_NOT_FOUND
The specified resource does not exist.
  • INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
  • INVALID_ACCOUNT_STATUS: Account validations failed for the user.

Create order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
RESOURCE_CONFLICT
The server has detected a conflict while processing this request.
  • PREVIOUS_REQUEST_IN_PROGRESS: A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
  • INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
  • INVALID_ARRAY_MAX_ITEMS: The number of items in an array parameter is too large.
     Possible error locations:
    • /purchase_units
    • /purchase_units/0/shipping/options
  • INVALID_ARRAY_MIN_ITEMS: The number of items in an array parameter is too small.
     Possible error locations:
    • /purchase_units
  • INVALID_COUNTRY_CODE: Country code is invalid. Please refer to https://developer.paypal.com/api/rest/reference/country-codes/ for a list of supported country codes.
     Possible error locations:
    • payer/address/country_code
    • purchase_units/0/shipping/address/country_code
    • payment_source/card/billing_address/country_code
    • payment_source/ideal/country_code
    • payment_source/bancomatpay/country_code
    • /payment_source/mbway/country_code
  • INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
     Possible error locations:
    • application_context/locale
    • payer/address/country_code
    • payer/birth_date
    • payer/email_address
    • payer/payer_id
    • payer/phone/phone_number/country_code
    • payer/phone/phone_number/extension_number
    • payer/phone/phone_number/national_number
    • purchase_units/0/amount/breakdown/handling/value
    • purchase_units/0/amount/breakdown/item_total/value
    • purchase_units/0/amount/breakdown/shipping/value
    • purchase_units/0/amount/breakdown/shipping_discount/value
    • purchase_units/0/amount/breakdown/discount/value
    • purchase_units/0/amount/breakdown/tax_total/value
    • purchase_units/0/amount/value
    • purchase_units/0/items/0/tax/value
    • purchase_units/0/items/1/unit_amount/value
    • purchase_units/0/payee/display_data/business_email
    • purchase_units/0/payee/email_address
    • purchase_units/0/payee/merchant_id
    • purchase_units/0/shipping/address/country_code
    • payment_source/paypal/experience_context/app_switch_preference/app_url
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long
     Possible error locations:
    • application_context/brand_name
    • application_context/locale
    • payer/address/admin_area1
    • payer/address/admin_area2
    • payer/address/address_line1
    • payer/address/address_line2
    • payer/address/country_code
    • payer/address/postal_code
    • payer/birth_date
    • payer/email_address
    • payer/external_id
    • payer/name/given_name
    • payer/name/surname
    • payer/payer_id
    • payer/phone/phone_number/country_code
    • payer/phone/phone_number/extension_number
    • payer/phone/phone_number/national_number
    • payer/tax_info/tax_id
    • purchase_units/0/amount/currency_code
    • purchase_units/0/custom_id
    • purchase_units/0/description
    • purchase_units/0/invoice_id
    • purchase_units/0/items/0/description
    • purchase_units/0/items/0/name
    • purchase_units/0/items/0/sku
    • purchase_units/0/items/0/tax/currency_code
    • purchase_units/0/items/0/unit_amount/currency_code
    • purchase_units/0/payee/display_data/business_email
    • purchase_units/0/payee/email_address
    • purchase_units/0/payee/merchant_id
    • purchase_units/0/payment_instruction/payee_pricing_tier_id
    • purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • purchase_units/0/reference_id
    • purchase_units/0/shipping/address/address_line1
    • purchase_units/0/shipping/address/address_line2
    • purchase_units/0/shipping/address/admin_area1
    • purchase_units/0/shipping/address/admin_area2
    • purchase_units/0/shipping/address/country_code
    • purchase_units/0/shipping/address/postal_code
    • purchase_units/0/soft_descriptor
    • /purchase_units/0/shipping/options/0/id
    • /purchase_units/0/shipping/options/0/label
    • payment_source/token/id
    • payment_source/card/billing_address/country_code
    • payment_source/google_pay/decrypted_token/cryptogram
    • payment_source/google_pay/decrypted_token/eci_indicator
    • payment_source/paypal/experience_context/app_switch_preference/os_type
    • payment_source/paypal/experience_context/app_switch_preference/os_version
  • INVALID_PARAMETER_VALUE: A parameter value is not valid.
     Possible error locations:
    • 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
    • payment_source/google_pay/decrypted_token/message_id
    • payment_source/google_pay/decrypted_token/message_expiration
    • payment_source/google_pay/decrypted_token/payment_method
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/decrypted_token/card
    • payment_source/paypal/experience_context/app_switch_preference/os_type
  • MISSING_REQUIRED_PARAMETER: A required parameter is missing.
     Possible error locations:
    • 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
    • payment_source/google_pay/decrypted_token/message_id
    • payment_source/google_pay/decrypted_token/message_expiration
    • payment_source/google_pay/decrypted_token/payment_method
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/decrypted_token/card
    • payment_source/google_pay/decrypted_token/card/number
    • payment_source/google_pay/decrypted_token/card/expiry
    • /payment_source/card/network_token/number
    • /payment_source/card/network_token/expiry
    • /payment_source/bancontact/attributes/mandate
    • /payment_source/bancontact/attributes/mandate/type
    • /payment_source/bancontact/attributes/customer
    • /payment_source/bancontact/attributes/customer/id
    • /payment_source/ideal/attributes/mandate
    • /payment_source/ideal/attributes/mandate/type
    • /payment_source/ideal/attributes/customer
    • /payment_source/ideal/attributes/customer/id
    • /payment_source/paypal/attributes/vault/owner_id
    • /payment_source/bank/sepa_debit/attributes/vault/store_in_vault
    • /payment_source/trustly/email
  • NOT_SUPPORTED: This field is not currently supported.
     Possible error locations:
    • payer/address/admin_area3
    • payer/address/admin_area4
    • payer/address/address_details/building_name
    • payer/address/address_details/delivery_service
    • payer/address/address_details/street_name
    • payer/address/address_details/street_number
    • payer/address/address_details/street_type
    • payer/address/address_details/sub_building
    • payer/address/address_line3
    • payer/name/alternate_full_name
    • payer/name/middle_name
    • payer/name/prefix
    • payer/name/suffix
    • payer/phone/phone_number/country_code
    • payer/phone/phone_number/extension_number
    • purchase_units/0/shipping/address/address_details/building_name
    • purchase_units/0/shipping/address/address_details/delivery_service
    • purchase_units/0/shipping/address/address_details/street_name
    • purchase_units/0/shipping/address/address_details/street_number
    • purchase_units/0/shipping/address/address_details/street_type
    • purchase_units/0/shipping/address/address_details/sub_building
    • purchase_units/0/shipping/address/address_line3
    • purchase_units/0/shipping/address/admin_area3
    • purchase_units/0/shipping/address/admin_area4
    • purchase_units/0/shipping/name/alternate_full_name
    • purchase_units/0/shipping/name/given_name
    • purchase_units/0/shipping/name/middle_name
    • purchase_units/0/shipping/name/prefix
    • purchase_units/0/shipping/name/suffix
    • purchase_units/0/shipping/name/surname
  • PAYPAL_REQUEST_ID_REQUIRED: A 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.
  • MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
  • PERMISSION_DENIED_FOR_DONATION_ITEMS: The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
  • MALFORMED_REQUEST: MALFORMED_REQUEST
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
  • AMOUNT_MISMATCH: Should equal item_total + tax_total + shipping + handling + insurance - shipping_discount - discount.
  • BILLING_AGREEMENTS_CANNOT_BE_USED_FOR_SUBSCRIPTIONS: Billing Agreements cannot be used for Subscription orders.
  • CANNOT_BE_NEGATIVE: Must be greater than or equal to 0. If the currency supports decimals, only two decimal place precision is supported.
  • CANNOT_BE_ZERO_OR_NEGATIVE: Must be greater than zero. If the currency supports decimals, only two decimal place precision is supported.
  • CARD_EXPIRED: The card is expired
  • MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
  • MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
  • CITY_REQUIRED: The specified country requires a city (address.admin_area_2).
  • DECIMAL_PRECISION: If the currency supports decimals, only two decimal place precision is supported.
  • DONATION_ITEMS_NOT_SUPPORTED: If 'purchase_unit' has "DONATION" as the 'items.category' then the Order can at most have one purchase_unit. Multiple purchase_units are not supported if either of them have at least one items with category as "DONATION".
  • DUPLICATE_REFERENCE_ID: reference_id must be unique if multiple purchase_unit are provided.
  • INVALID_CURRENCY_CODE: Currency code is invalid or is not currently supported. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
  • INVALID_PAYER_ID: The payer ID is not valid.
  • ITEM_TOTAL_MISMATCH: Should equal sum of (unit_amount * quantity) across all items for a given purchase_unit.
  • ITEM_TOTAL_REQUIRED: If item details are specified (items.unit_amount and items.quantity) corresponding amount.breakdown.item_total is required.
  • MAX_VALUE_EXCEEDED: Should be less than or equal to 999999999999999.99.
  • PAYMENT_DENIED: PayPal has declined to process this transaction.
  • MISSING_PICKUP_ADDRESS: A pickup address(shipping.address) is required for the provided shipping.type.
     Possible error locations:
    • /purchase_units/0/shipping/type
  • MULTI_CURRENCY_ORDER: Multiple differing values of currency_code are not supported. Entire Order request must have the same currency_code.
  • MULTIPLE_ITEM_CATEGORIES: For a given 'purchase_unit' the '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".
  • MULTIPLE_SHIPPING_ADDRESS_NOT_SUPPORTED: Multiple shipping addresses are not supported.
  • MULTIPLE_SHIPPING_TYPE_NOT_SUPPORTED: Different shipping.type are not supported across purchase units nor within an individual item's shipping options.
  • PAYEE_ACCOUNT_INVALID: Payee account specified is invalid. Please check the payee.email_address or payee.merchant_id specified and try again. Ensure that either payee.merchant_id or payee.email_address is specified.
  • PAYEE_ACCOUNT_LOCKED_OR_CLOSED: The merchant account is locked or closed.
  • PAYEE_ACCOUNT_RESTRICTED: The merchant account is restricted.
  • PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
  • PAYEE_PRICING_TIER_ID_NOT_ENABLED: The API Caller is not enabled to process transactions by specifying a 'payee_pricing_tier_id'. Please work with your Account Manager to enable this option for your account.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_pricing_tier_id
    • /purchase_units//payment_instruction/payee_pricing_tier_id
  • INVALID_PAYEE_PRICING_TIER_ID: Please check the value specified or confirm with your Account Manager that the 'payee_pricing_tier_id' specified has been setup for the account.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_pricing_tier_id
    • /purchase_units//payment_instruction/payee_pricing_tier_id
  • UNSUPPORTED_PAYMENT_SOURCE_FOR_SUBSCRIPTIONS: The specified payment source is not supported for subscriptions. Only a vault_id or vault_setup_token with payment_source.card and payment_source.paypal are supported.
     Possible error locations:
    • /payment_source
  • PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • /purchase_units//payment_instruction/payee_receivable_fx_rate_id
  • PAYEE_FX_RATE_ID_CURRENCY_MISMATCH: The specified FX Rate ID is for a currency that does not match with the currency of this request. Please specify a different FX Rate ID and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • /purchase_units//payment_instruction/payee_receivable_fx_rate_id
  • INVALID_FX_RATE_ID: The specific FX Rate ID is not valid. This could be either because we are not able to look up the FX Rate based on this ID or it could be because the ID belongs to another API Caller.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • /purchase_units//payment_instruction/payee_receivable_fx_rate_id
  • PLATFORM_FEES_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying 'platform_fees'. Please work with your PayPal Account Manager to enable this option for your account.
     Possible error locations:
    • /purchase_units/0/payment_instruction/platform_fees
    • /purchase_units//payment_instruction/platform_fees
  • INVALID_PLATFORM_FEES_ACCOUNT: The specified platform_fees payee account is either invalid or account setup is incomplete.Please work with your PayPal Account Manager to enable this option for your account.
     Possible error locations:
    • /purchase_units/0/payment_instruction/platform_fees/0/payee
    • /purchase_units//payment_instruction/platform_fees/0/payee
  • INVALID_PLATFORM_FEES_AMOUNT: The platform_fees amount cannot be greater than order amount.
     Possible error locations:
    • /purchase_units/0/payment_instruction/platform_fees/0/amount/value
    • /purchase_units//payment_instruction/platform_fees/0/value
  • POSTAL_CODE_REQUIRED: The specified country requires a postal code.
  • REFERENCE_ID_REQUIRED: 'reference_id' is required for each 'purchase_unit' if multiple 'purchase_unit' are provided.
  • SHIPPING_OPTIONS_NOT_SUPPORTED: Shipping options are not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
  • TAX_TOTAL_MISMATCH: Should equal sum of (tax * quantity) across all items for a given purchase_unit.
  • TAX_TOTAL_REQUIRED: If item details are specified (items.tax_total and items.quantity) corresponding amount.breakdown.tax_total is required.
  • UNSUPPORTED_INTENT: intent=AUTHORIZE is not supported for this operation. Only intent=CAPTURE is supported.
  • UNSUPPORTED_PAYMENT_INSTRUCTION: You must provide the payment instruction when you capture an authorized payment for intent=AUTHORIZE. For details, see Capture authorization. For intent=CAPTURE, send the payment instruction when you create the order.
  • SHIPPING_TYPE_NOT_SUPPORTED_FOR_CLIENT: The API Caller account is not setup to be able to support a shipping.type=PICKUP_IN_PERSON. This feature is only supported for PayPal Complete Payments Platform for Platforms and Marketplaces.
  • UNSUPPORTED_SHIPPING_TYPE: The provided shipping.type is only supported for application_context.shipping_preference=SET_PROVIDED_ADDRESS or NO_SHIPPING.
     Possible error locations:
    • /purchase_units/0/shipping/type
  • SHIPPING_OPTION_NOT_SELECTED: At least one of the shipping.option should be set to 'selected = true'.
  • MULTIPLE_SHIPPING_OPTION_SELECTED: Only one shipping.option can be set to 'selected = true'.
  • INVALID_SHIPPING_OPTION_ID: The items.shipping.options_ids[].id does not exist in purchase_units.shipping.options[]. Please ensure that all ids used in options_ids are first defined in purchase_units.shipping.options[].
     Possible error locations:
    • /purchase_units/0/items/0/shipping/options_ids/0/id
  • INVALID_DELIVERY_ESTIMATE: The provided delivery_time_max must be greater than the delivery_time_min, and vice versa.
     Possible error locations:
    • /purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_min
    • /purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_max
  • INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
  • MISSING_SHIPPING_CALL_BACK_CONFIGURATION: payment_source.paypal.experience_context.order_update_callback_config is mandatory for one or more shipping.options provided in the request.
  • MISSING_ITEM_SHIPPING_OPTIONS: All items in the purchase_unit must have options_ids defined if any item in the Order has item[].shipping.options_ids defined.
  • PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH: The amount provided in the preferred shipping option should match the amount provided in amount breakdown
     Possible error locations:
    • /purchase_units/0/shipping/options/0/amount/value
  • AGREEMENT_ALREADY_CANCELLED: The requested agreement is already canceled.
  • BILLING_AGREEMENT_NOT_FOUND: The requested Billing Agreement token was not found.
  • COMPLIANCE_VIOLATION: Transaction is declined due to compliance violation.
  • DOMESTIC_TRANSACTION_REQUIRED: This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
  • DUPLICATE_INVOICE_ID: Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
  • INSTRUMENT_DECLINED: The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
  • MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED: You have exceeded the maximum number of payment attempts.
  • NOT_ENABLED_FOR_CARD_PROCESSING: The API Caller account is not setup to be able to process card payments. Please contact PayPal customer support.
  • PAYEE_BLOCKED_TRANSACTION: Declined by fraud tool (Fraud Protection/Chargeback Protection) due to potential fraud risk. Please review your fraud settings.
  • PAYER_ACCOUNT_LOCKED_OR_CLOSED: The payer account cannot be used for this transaction.
  • PAYER_ACCOUNT_RESTRICTED: PAYER_ACCOUNT_RESTRICTED
  • PAYER_CANNOT_PAY: Combination of payer and payee settings mean that this buyer cannot pay this seller.
  • TRANSACTION_BLOCKED_BY_PAYEE: Transaction blocked by Payee’s Fraud Protection settings.
  • TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
  • TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the receiver's receiving limit.
  • TRANSACTION_REFUSED: The request was refused.
  • AUTH_CAPTURE_NOT_ENABLED: Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
  • UNSUPPORTED_PROCESSING_INSTRUCTION: The specified processing_instruction is not supported for the given payment_source. Please refer to https://developer.paypal.com/api/orders/v2/#definition-processing_instruction for the list of payment_source that can be specified with this value.
  • ORDER_COMPLETE_ON_PAYMENT_APPROVAL: A processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL is required for the specified payment_source. Please refer to the integration guide https://developer.paypal.com/docs/limited-release/alternative-payment-methods-with-orders/ for more details
  • INVALID_EXPIRY_DATE: Expiry date is invalid. Expiry date should be a date in future and within the threshold for the payment source.
     Possible error locations:
    • payment_source/oxxo/expiry_date
    • payment_source/boletobancario/expiry_date
  • INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
     Possible error locations:
    • application_context/stored_payment_source/payment_initiator
    • application_context/stored_payment_source/payment_type
    • application_context/stored_payment_source/usage
    • application_context/stored_payment_source/previous_transaction_reference
    • application_context/stored_payment_source/previous_network_transaction_reference
    • payment_source/paypal/experience_context/brand_name
    • payment_source/paypal/experience_context/locale
    • payment_source/paypal/experience_context/shipping_preference
    • payment_source/paypal/experience_context/return_url
    • payment_source/paypal/experience_context/cancel_url
    • payment_source/paypal/experience_context/landing_page
    • payment_source/paypal/experience_context/user_action
    • payment_source/paypal/experience_context/payment_method_preference
    • payment_source/paypal/experience_context/payment_method_selected
    • application_context/brand_name
    • application_context/locale
    • application_context/shipping_preference
    • application_context/return_url
    • application_context/cancel_url
    • application_context/landing_page
    • application_context/user_action
    • application_context/payment_method/payee_preferred
    • application_context/payment_method/payer_selected
    • payment_source/paypal/payment_method_preference
    • payment_source/paypal/email_address
    • payment_source/paypal/name
    • payment_source/paypal/birth_date
    • payment_source/paypal/tax_info
    • payment_source/paypal/address
    • payer/email_address
    • payer/name
    • payer/birth_date
    • payer/tax_info
    • payer/address
    • payment_source/card/attributes/vault/confirm_payment_token
    • payment_source/card/attributes/vault/store_in_vault
    • payment_source/paypal/attributes/vault/confirm_payment_token
    • payment_source/paypal/attributes/vault/store_in_vault
    • payment_source/apple_pay/attributes/vault/store_in_vault
    • payment_source/card/number
    • payment_source/card/vault_id
    • payment_source/card/stored_credential
    • payment_source/apple_pay/stored_credential
    • application_context/stored_payment_source
    • payment_source/paypal/vault_id
    • payment_source/venmo/vault_id
    • payment_source/apple_pay/vault_id
    • payment_source/card/attributes/vault
    • payment_source/paypal/attributes/vault
    • payment_source/venmo/attributes/vault
    • payment_source/google_pay/decrypted_token/cryptogram
    • payment_source/google_pay/decrypted_token/eci_indicator
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/token
    • payment_source/google_pay/decrypted_token
    • payment_source/card/paypal_transaction_id
    • payment_source/card/pnref
    • payment_source/paypal/billing_agreement_id
    • payment_source/apple_pay/attributes/vault
    • payment_source/apple_pay/decrypted_token/payment_data/cryptogram
    • /payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
    • payment_source/google_pay/decrypted_token/cryptogram
    • payment_source/google_pay/decrypted_token/eci_indicator
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/token
    • payment_source/google_pay/decrypted_token
    • /payment_source/card/attributes/payment_origin
    • payment_source/bank/sepa_debit/stored_credential/payment_initiator
    • payment_source/bank/sepa_debit/stored_credential/payment_type
    • payment_source/bank/sepa_debit/vault_id
    • payment_source/bank/sepa_debit/iban
    • payment_source/bank/sepa_debit/account_holder_name
    • payment_source/bank/sepa_debit/billing_address
    • payment_source/bank/sepa_debit/attributes/mandate/type
    • payment_source/bank/sepa_debit/stored_credential/payment_type
    • payment_source/bank/ach_debit/account_number
    • payment_source/bank/ach_debit/routing_number
    • payment_source/bank/ach_debit/account_type
    • payment_source/bank/ach_debit/account_holder_name
    • payment_source/bank/ach_debit/vault_id
    • payment_source/bank/ach_debit/attributes/vault
    • payment_source/bank/ach_debit/stored_credential
  • INVALID_PREVIOUS_TRANSACTION_REFERENCE: The authorization or capture referenced by previous_transaction_reference is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid previous_transaction_reference.
  • PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK: The capture referenced by previous_transaction_reference has a chargeback and hence cannot be used for this order. Please use a previous_transaction_reference which does not have a chargeback.
  • PREVIOUS_TRANSACTION_REFERENCE_VOIDED: The status of authorization referenced by previous_transaction_reference is VOIDED and hence cannot be used for this order. Please use a previous_transaction_reference whose status is not VOIDED.
  • PAYMENT_SOURCE_MISMATCH: The payment_source in the request must match the payment_source used for the authorization or capture referenced by previous_transaction_reference. Please use previous_transaction_reference whose payment_source matches with the payment_source specified in the order.
  • MERCHANT_INITIATED_WITH_SECURITY_CODE: stored_payment_source.payment_initiator = MERCHANT is not supported if payment_source.card.security_code is present in the order. security_code can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with security_code is the order.
  • MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS: stored_payment_source.payment_initiator = MERCHANT is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order.
  • MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS: stored_payment_source.payment_initiator = MERCHANT is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit).
  • PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED: The combination of the payment_source name, billing address, shipping name and shipping address could not be verified. Please correct this information and try again by creating a new order.
  • PAYMENT_SOURCE_DECLINED_BY_PROCESSOR: The provided payment source is declined by the processor. Please try again with a different payment source by creating a new order.
  • PAYMENT_SOURCE_CANNOT_BE_USED: The provided payment source cannot be used to pay for the order. Please try again with a different payment source by creating a new order.
  • NOT_ENABLED_FOR_APPLE_PAY: The 'API caller' and/or 'payee' is not setup to be able to process apple pay. Please contact your Account Manager.
  • NOT_ENABLED_FOR_GOOGLE_PAY: The 'API caller' and/or 'payee' is not setup to be able to process google pay. Please contact your Account Manager.
  • APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
  • BILLING_ADDRESS_INVALID: Provided billing address is invalid.
     Possible error locations:
    • /payment_source/pay_upon_invoice/billing_address
  • SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
     Possible error locations:
    • purchase_units/0/shipping/address
  • VAULT_INSTRUCTION_DUPLICATED: Only one vault instruction is allowed. Please use vault.store_in_vault to provide vault instruction.
  • VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
  • MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact your account manager to enable the functionality.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
     Possible error locations:
    • payment_source/venmo/vault_id
    • payment_source/card/vault_id
    • payment_source/paypal/vault_id
    • payment_source/apple_pay/vault_id
    • payment_source/bank/sepa_debit/vault_id
  • MISMATCHED_VAULT_SETUP_TOKEN_TO_PAYMENT_SOURCE: The vault_setup_token does not match the payment_source provided. Please verify that the vault_setup_token token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_setup_token field in the payment_source.card object.
     Possible error locations:
    • payment_source/card/vault_setup_token
    • payment_source/paypal/vault_setup_token
  • CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/payment_data/cryptogram
  • EMV_DATA_REQUIRED: EMV Data is required if authentication method is EMV.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/payment_data/emv_data
  • NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
  • NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
  • PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
  • PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
  • INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
     Possible error locations:
    • payment_source/card/security_code
  • NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE: The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance.
  • REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/transaction_amount
    • /payment_source/apple_pay/decrypted_token/payment_data
    • /payment_source/apple_pay/decrypted_token/payment_data_type
    • /payment_source/apple_pay/decrypted_token/device_manufacturer_id
  • TOKEN_EXPIRED: The token is expired and cannot be used for payment.
     Possible error locations:
    • payment_source/google_pay/decrypted_token/message_expiration
    • payment_source/google_pay/token
  • INVALID_GOOGLE_PAY_TOKEN: The google pay token is invalid. PayPal was not able to decrypt the googlepay token or PayPal was not able to find the necessary data in the token after decryption.
     Possible error locations:
    • /payment_source/google_pay/token
  • GOOGLE_PAY_GATEWAY_MERCHANT_ID_MISMATCH: The gateway merchant ID in Google Pay token is not valid. This could be because the gateway merchant Id that was authorized by payer/buyer on Google Pay does not match with the API caller of the order.
     Possible error locations:
    • /payment_source/google_pay/token
  • CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
     Possible error locations:
    • /payment_source/google_pay/decrypted_token/cryptogram
  • ONE_OF_PARAMETERS_REQUIRED: One or more field is required to continue with this request.
     Possible error locations:
    • /payment_source/google_pay/token
    • /payment_source/google_pay/decrypted_token
    • payment_source/blik/experience_context/consumer_ip
    • payment_source/blik/experience_context/consumer_user_agent
  • ALIAS_DECLINED_BY_PROCESSOR: The provided alias was declined by the processor. Please create a new order with a different alias_key and/or alias_label and try again.
  • PREFERRED_BRAND_NOT_SUPPORTED: Processing of this preferred brand is not supported. Please use another brand preference to continue with this transaction.
  • BLIK_ONE_CLICK_MISSING_REQUIRED_PARAMETER: Blik's one_click flow requires one_click.auth_code and one_click.alias_label parameters for the buyer's first transaction. For all subsequent transactions,only the one_click.alias_key parameter is required.
     Possible error locations:
    • payment_source/blik/one_click/auth_code
    • payment_source/blik/one_click/alias_label
    • payment_source/blik/one_click/alias_key
  • INCOMPATIBLE_ACCOUNT_OWNERSHIP_TYPE: Account ownership type is not compatible with standard entry class code.
  • DELAYED_DISBURSEMENT_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying disbursement mode as delayed.
     Possible error locations:
    • /purchase_units/0/payment_instruction/disbursement_mode
    • /purchase_units//payment_instruction/disbursement_mode
  • NOT_ENABLED_FOR_PAYMENT_SOURCE: The 'API caller' and/or 'payee' is not setup to be able to process the selected payment source. If you have already completed the required steps, please allow 2 business days for PayPal to complete the setup. If you continue to receive this error, please contact your Account Manager or check status at https://www.paypal.com/businessmanage/account/payments.
     Possible error locations:
    • /payment_source/alipay
    • /payment_source/bancomatpay
    • /payment_source/bancontact
    • /payment_source/blik
    • /payment_source/boletobancario
    • /payment_source/eps
    • /payment_source/giropay
    • /payment_source/ideal
    • /payment_source/mbway
    • /payment_source/mybank
    • /payment_source/multibanco
    • /payment_source/oxxo
    • /payment_source/payu
    • /payment_source/p24
    • /payment_source/paidy
    • /payment_source/safetypay
    • /payment_source/satispay
    • /payment_source/trustly
    • /payment_source/wechatpay
  • INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
     Possible error locations:
    • /payment_source/paypal/vault_id
  • MULTIPLE_PURCHASE_UNITS_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: The provided payment source cannot be used to pay for the multiple purchase units order.
     Possible error locations:
    • /payment_source/alipay
    • /payment_source/bancomatpay
    • /payment_source/bancontact
    • /payment_source/blik
    • /payment_source/eps
    • /payment_source/ideal
    • /payment_source/mbway
    • /payment_source/mybank
    • /payment_source/oxxo
    • /payment_source/payu
    • /payment_source/p24
    • /payment_source/trustly
    • /payment_source/wechatpay
    • /payment_source/grabpay
    • /payment_source/multibanco
    • /payment_source/satispay
    • /payment_source/pay_upon_invoice
  • COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Country code provided is not supported by the provided payment source.
     Possible error locations:
    • /payment_source/ach_debit/billing_address/country_code
  • LOCALE_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Locale provided is not supported by the provided payment source.
     Possible error locations:
    • /payment_source/ach_debit/experience_context/locale
  • BANK_VERIFICATION_REQUIRED: Only verified bank accounts can be processed.
     Possible error locations:
    • /payment_source/ach_debit/attributes/verification
  • SHIPPING_CALLBACK_CONFIG_NOT_SUPPORTED: The shipping address callback URL in 'order_update_callback_config' field is not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
  • MISSING_REQUIRED_PARAMETER_FOR_BILLING_PLAN: PayPal Vault billing plan requires usage_pattern to be passed in the request. Supported Values: SUBSCRIPTION, UNSCHEDULED, RECURRING, INSTALLMENT (prepaid/postpaid)
  • UNSUPPORTED_INTEGRATION_FOR_BILLING_PLAN: For Recurring Purchases, passing billing plan and vaulting instruction (in payment_source.paypal.attributes.vault or payment_source.paypal.billing) is mandatory. Also, only one billing plan, product and purchase unit are supported.
  • INCOMPATIBLE_PARAMETER_FOR_BILLING_PLAN: For Recurring Purchase, amount fields like handling, insurance, discount and shipping discount are unsupported.
  • BILLING_ITEM_AMOUNT_MISMATCH: For Recurring Purchases, the billing plan’s unit amount should include both the setup fee and the plan price (only if the plan starts immediately, i.e. no start_date).

Patch order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
  • INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
  • FIELD_NOT_PATCHABLE: Field cannot be patched.
     Possible error locations:
    • id
    • status
  • INVALID_ARRAY_MAX_ITEMS: The number of items in an array parameter is too large.
     Possible error locations:
    • /purchase_units/0/shipping/options
  • INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
     Possible error locations:
    • /purchase_units/0/payee/email_address
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long
     Possible error locations:
    • /purchase_units/0/shipping/options/0/id
    • /purchase_units/0/shipping/options/0/label
  • INVALID_PARAMETER_VALUE: The value of a field is invalid.
     Possible error locations:
    • op
  • MISSING_REQUIRED_PARAMETER: A required field / parameter is missing.
     Possible error locations:
    • op
    • /purchase_units/0/shipping/options/0/id
    • /purchase_units/0/shipping/options/0/label
    • /purchase_units/0/shipping/options/0/selected
  • AMOUNT_NOT_PATCHABLE: The amount cannot be updated as the 'payer' has chosen and approved a specific financing offer for a given amount. Please Create a new Order with the updated Order amount and have the 'payer' approve the new payment terms.
     Possible error locations:
    • /purchase_units/0/amount
  • INVALID_PATCH_OPERATION: The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add.
     Possible error locations:
    • op
  • MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
  • PAYEE_ACCOUNT_NOT_SUPPORTED: Payee does not have an account. Your current setup requires the 'payee' to have a verified account with PayPal before you can process transactions on their behalf.
  • PAYEE_ACCOUNT_NOT_VERIFIED: Payee has not verified their account with PayPal. The selected payment method requires the recipient to have a verified PayPal account before transactions can be processed on their behalf.
  • PAYEE_NOT_CONSENTED: Payee does not have appropriate consent to allow the API caller to process this type of transaction on their behalf. Your current setup requires the 'payee' to provide a consent before this transaction can be processed successfully.
RESOURCE_NOT_FOUND
The specified resource does not exist.
  • INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
  • AMOUNT_MISMATCH: Should equal item_total + tax_total + shipping + handling + insurance - shipping_discount - discount.
  • CANNOT_BE_NEGATIVE: Must be greater than or equal to 0. If the currency supports decimals, only two decimal place precision is supported.
  • CANNOT_BE_ZERO_OR_NEGATIVE: Must be greater than zero. If the currency supports decimals, only two decimal place precision is supported.
  • CITY_REQUIRED: The specified country requires a city (address.admin_area_2).
  • DECIMAL_PRECISION: If the currency supports decimals, only two decimal place precision is supported.
  • DONATION_ITEMS_NOT_SUPPORTED: If 'purchase_unit' has "DONATION" as the 'items.category' then the Order can at most have one purchase_unit. Multiple purchase_units are not supported if either of them have at least one items with category as "DONATION".
  • DUPLICATE_REFERENCE_ID: reference_id must be unique if multiple purchase_unit are provided.
  • INVALID_CURRENCY_CODE: Currency code is invalid or is not currently supported. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
  • ITEM_TOTAL_MISMATCH: Should equal sum of (unit_amount * quantity) across all items for a given purchase_unit.
  • ITEM_TOTAL_REQUIRED: If item details are specified (items.unit_amount and items.quantity) corresponding amount.breakdown.item_total is required.
  • MAX_VALUE_EXCEEDED: Should be less than or equal to 999999999999999.99.
  • INVALID_JSON_POINTER_FORMAT: Path should be a valid JSON Pointer https://tools.ietf.org/html/rfc6901 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.
  • TAX_TOTAL_MISMATCH: Should equal sum of (tax * quantity) across all items for a given purchase_unit.
  • TAX_TOTAL_REQUIRED: If item details are specified (items.tax_total and items.quantity) corresponding amount.breakdown.tax_total is required.
  • UNSUPPORTED_INTENT: intent=AUTHORIZE is not supported for multiple purchase units. Only intent=CAPTURE is supported.
  • UNSUPPORTED_PATCH_PARAMETER_VALUE: The value specified for this field is not currently supported.
  • PATCH_VALUE_REQUIRED: Please specify a 'value' to for the field that is being patched.
  • PATCH_PATH_REQUIRED: Please specify a 'path' for the field for which the operation needs to be performed.
  • PAYEE_ACCOUNT_LOCKED_OR_CLOSED: The merchant account is locked or closed.
  • PAYEE_ACCOUNT_RESTRICTED: The merchant account is restricted.
  • PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • /purchase_units//payment_instruction/payee_receivable_fx_rate_id
  • PAYEE_FX_RATE_ID_CURRENCY_MISMATCH: The specified FX Rate ID is for a currency that does not match with the currency of this request. Please specify a different FX Rate ID and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • /purchase_units//payment_instruction/payee_receivable_fx_rate_id
  • INVALID_FX_RATE_ID: The specific FX Rate ID is not valid. This could be either because we are not able to look up the FX Rate based on this ID or it could be because the ID belongs to another API Caller.
     Possible error locations:
    • /purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
    • /purchase_units//payment_instruction/payee_receivable_fx_rate_id
  • PLATFORM_FEES_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying 'platform_fees'. Please work with your PayPal Account Manager to enable this option for your account.
     Possible error locations:
    • /purchase_units/0/payment_instruction/platform_fees
    • /purchase_units//payment_instruction/platform_fees
  • INVALID_PLATFORM_FEES_ACCOUNT: The specified platform_fees payee account is either invalid or account setup is incomplete.Please work with your PayPal Account Manager to enable this option for your account.
     Possible error locations:
    • /purchase_units/0/payment_instruction/platform_fees/0/payee
    • /purchase_units//payment_instruction/platform_fees/0/payee
  • INVALID_PLATFORM_FEES_AMOUNT: The platform_fees amount cannot be greater than order amount.
     Possible error locations:
    • /purchase_units/0/payment_instruction/platform_fees/0/amount/value
    • /purchase_units//payment_instruction/platform_fees/0/value
  • POSTAL_CODE_REQUIRED: The specified country requires a postal code.
  • REFERENCE_ID_NOT_FOUND: Filter expression value is incorrect. Please check the value of the reference_id and try again.
  • REFERENCE_ID_REQUIRED: 'reference_id' is required for each 'purchase_unit' if multiple 'purchase_unit' are provided.
  • MULTI_CURRENCY_ORDER: Multiple differing values of currency_code are not supported. Entire Order request must have the same currency_code.
  • INVALID_SHIPPING_OPTION_ID: The items.shipping.options_ids[].id does not exist in purchase_units.shipping.options[]. Please ensure that all ids used in options_ids are first defined in purchase_units.shipping.options[].
     Possible error locations:
    • /purchase_units/0/items/0/shipping/options_ids/0/id
  • INVALID_DELIVERY_ESTIMATE: The provided delivery_time_max must be greater than the delivery_time_min, and vice versa.
     Possible error locations:
    • /purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_min
    • /purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_max
  • INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
  • MISSING_SHIPPING_CALL_BACK_CONFIGURATION: payment_source.paypal.experience_context.order_update_callback_config is mandatory for one or more shipping.options provided in the request.
  • MISSING_ITEM_SHIPPING_OPTIONS: All items in the purchase_unit must have options_ids defined if any item in the Order has item[].shipping.options_ids defined.
  • 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 shipping.type is specified or when 'payment_source.paypal.experience_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
  • MULTIPLE_SHIPPING_OPTION_SELECTED: Only one shipping.option can be set to 'selected = true'.
  • DUPLICATE_SHIPPING_OPTION_ID: Please specify a unique shipping option id for each shipping option provided in the request and try again.
  • ORDER_ALREADY_COMPLETED: The order cannot be patched after it is completed.
  • CANNOT_MODIFY_INTENT: The value of 'intent' cannot be changed. Please create a new order.
  • PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH: The amount provided in the preferred shipping option should match the amount provided in amount breakdown
     Possible error locations:
    • /purchase_units/0/shipping/options/0/amount/value
  • AMOUNT_CHANGE_NOT_ALLOWED: The amount specified is different from the amount authorized by payer.
  • DELAYED_DISBURSEMENT_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying disbursement mode as delayed.
     Possible error locations:
    • /purchase_units/0/payment_instruction/disbursement_mode
    • /purchase_units//payment_instruction/disbursement_mode
  • MULTIPLE_PURCHASE_UNITS_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: The provided payment source cannot be used to pay for the multiple purchase units order.
     Possible error locations:
    • /payment_source/alipay
    • /payment_source/bancomatpay
    • /payment_source/bancontact
    • /payment_source/blik
    • /payment_source/eps
    • /payment_source/ideal
    • /payment_source/mbway
    • /payment_source/mybank
    • /payment_source/oxxo
    • /payment_source/payu
    • /payment_source/p24
    • /payment_source/trustly
    • /payment_source/wechatpay
    • /payment_source/grabpay
    • /payment_source/multibanco
    • /payment_source/satispay
    • /payment_source/pay_upon_invoice

Authorize order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
RESOURCE_CONFLICT
The server has detected a conflict while processing this request.
  • PREVIOUS_REQUEST_IN_PROGRESS: A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
  • INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
  • INVALID_COUNTRY_CODE: Country code is invalid. Please refer to https://developer.paypal.com/api/rest/reference/country-codes/ for a list of supported country codes.
     Possible error locations:
    • payment_source/card/billing_address/country_code
  • INVALID_PARAMETER_VALUE: A parameter value is not valid.
     Possible error locations:
    • Prefer
    • payment_source/token/type
    • payment_source/google_pay/decrypted_token/payment_method
    • payment_source/google_pay/decrypted_token/authentication_method
  • MISSING_REQUIRED_PARAMETER: A required field / parameter is missing
     Possible error locations:
    • payment_source/token/id
    • payment_source/token/type
    • payment_source/card/expiry
    • /payment_source/paypal/attributes/vault/confirm_payment_token
    • /payment_source/paypal/attributes/vault/usage_type
    • /payment_source/card/attributes/vault/confirm_payment_token
    • payment_source/google_pay/decrypted_token/card
    • payment_source/google_pay/decrypted_token/card/number
    • payment_source/google_pay/decrypted_token/card/expiry
    • /payment_source/card/network_token/number
    • /payment_source/card/network_token/expiry
    • /payment_source/paypal/attributes/vault/owner_id
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long
     Possible error locations:
    • payment_source/token/id
    • payment_source/card/billing_address/country_code
    • /payment_source/paypal/attributes/customer/id
    • payment_source/google_pay/decrypted_token/eci_indicator
    • payment_source/google_pay/decrypted_token/cryptogram
    • /payment_source/apple_pay/attributes/customer/id
  • INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/usage_type
    • /payment_source/paypal/attributes/vault/customer_type
    • /payment_source/paypal/attributes/vault/confirm_payment_token
    • /payment_source/paypal/attributes/customer/id
    • /payment_source/card/attributes/customer/id
    • /payment_source/apple_pay/attributes/customer/id
    • /payment_source/card/attributes/vault/confirm_payment_token
    • /payment_source/paypal/payment_method_preference
    • payment_source/google_pay/decrypted_token/eci_indicator
  • MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • NOT_ELIGIBLE_FOR_TOKEN_PROCESSING: API caller is not enabled to process payments with the specified type of token. Please contact customer support to request permissions to process transactions with this type of token.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
  • PERMISSION_DENIED_FOR_DONATION_ITEMS: The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
RESOURCE_NOT_FOUND
The specified resource does not exist.
  • INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
  • ACTION_DOES_NOT_MATCH_INTENT: Order was created with an intent to 'CAPTURE'. Please use v2/checkout/orders/order_id/capture to complete the transaction or alternately Create an order with an intent of 'AUTHORIZE'.
  • PREFERRED_BRAND_NOT_SUPPORTED: Processing of this preferred brand is not supported. Please use another brand preference to continue with this transaction.
  • AGREEMENT_ALREADY_CANCELLED: The requested agreement is already canceled.
  • BILLING_AGREEMENT_NOT_FOUND: The requested Billing Agreement token was not found.
  • MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
  • MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
  • CARD_BRAND_NOT_SUPPORTED: Processing of this card brand is not supported. Please use another card to continue with this transaction.
  • CARD_COUNTRY_NOT_SUPPORTED: The country in which this card was issued is not currently supported. Please use another card to continue with this transaction.
     Possible error locations:
    • /payment_source/card/billing_address/country_code
  • CARD_DATA_NOT_FOUND: The card issuer data information could not be retrieved. Please use a different card to proceed with this transaction.
     Possible error locations:
    • /payment_source/card/number
  • DECLINED_DUE_TO_RELATED_TXN: One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed.
  • DOMESTIC_TRANSACTION_REQUIRED: This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
  • DUPLICATE_INVOICE_ID: Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
  • ORDER_NOT_APPROVED: Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call.
  • MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED: You have exceeded the maximum number of payment attempts.
  • PAYEE_BLOCKED_TRANSACTION: Declined by fraud tool (Fraud Protection/Chargeback Protection) due to potential fraud risk. Please review your fraud settings.
  • CONTINGENCY_NOT_SUCCESSFUL: 3D-Secure payer authentication is unsuccessful, so the payment cannot be completed.
  • PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
  • UNSUPPORTED_INTENT_FOR_PAYMENT_SOURCE: intent=AUTHORIZE is not supported for the specified payment_source. Only intent=CAPTURE is supported.
  • INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
  • PAYER_ACCOUNT_LOCKED_OR_CLOSED: The payer account cannot be used for this transaction.
  • PAYER_ACCOUNT_RESTRICTED: PAYER_ACCOUNT_RESTRICTED
  • PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
  • PAYER_CANNOT_PAY: Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
  • PAYPAL_TRANSACTION_ID_EXPIRED: Specified paypal_transaction_id has expired. PayPal transaction ID expires 4 years after the date of the initial transaction.
  • PNREF_EXPIRED: Specified pnref has expired. PNREF expires 15 months after the date of the initial transaction.
  • PAYMENT_DENIED: PayPal has declined to process this transaction.
  • REFERENCED_CARD_EXPIRED: The card underlying the token has expired and hence cannot be used to process a payment.
  • TOKEN_EXPIRED: The token is expired and cannot be used for payment.
     Possible error locations:
    • payment_source/google_pay/decrypted_token/message_expiration
    • payment_source/google_pay/token
  • TOKEN_ID_NOT_FOUND: Specified token was not found. Verify the token and try the request again.
  • TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
  • TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the receiver's receiving limit.
  • TRANSACTION_REFUSED: The request was refused.
  • ORDER_ALREADY_AUTHORIZED: Order already authorized.If 'intent=AUTHORIZE' only one authorization per order is allowed.
  • AUTH_CAPTURE_NOT_ENABLED: Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
  • AMOUNT_CANNOT_BE_SPECIFIED: An authorization amount can only be specified if an Order has been saved by calling /v2/checkout/orders/{order_id}/save. Please save the order and try again.
  • AUTHORIZATION_AMOUNT_EXCEEDED: Authorization amount specified exceeded allowable limit. Specify a different amount and try the request again. Alternately, contact Customer Support to increase your limits. Local regulations (e.g. in PSD2 countries) prohibit overages above the amount authorized by the payer.
  • AUTHORIZATION_CURRENCY_MISMATCH: The currency of the authorization should be same as that in which the Order was created and approved by the Payer. Please check the 'currency_code' and try again.
  • MAX_AUTHORIZATION_COUNT_EXCEEDED: Maximum number of authorization allowed for the order is reached. Please contact Customer Support if you need to increase your limit.
  • ORDER_COMPLETED_OR_VOIDED: Order is voided or completed and hence cannot be authorized.
  • ORDER_EXPIRED: Order is expired and hence cannot be authorized. Please contact Customer Support if you need to increase your order validity period.
  • INVALID_PICKUP_ADDRESS: If the 'shipping_option.type' is set as 'PICKUP' then the 'shipping_detail.name.full_name' should start with 'S2S' meaning Ship To Store. Example: 'S2S My Store'.
  • SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
  • PAYMENT_TYPE_NOT_SUPPORTED_FOR_INTENT: Provided payment type not supported for order intent. Payment authorizations are supported only for order with intent=AUTHORIZE and payment captures are supported only for order with intent=CAPTURE.
  • BILLING_AGREEMENT_ID_MISMATCH: Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation.
  • PREFERRED_PAYMENT_SOURCE_MISMATCH: Payment Source must exactly match the Preferred Payment Source that was provided during order creation.
  • INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
     Possible error locations:
    • application_context/stored_payment_source/payment_initiator
    • application_context/stored_payment_source/payment_type
    • application_context/stored_payment_source/usage
    • application_context/stored_payment_source/previous_transaction_reference
    • application_context/stored_payment_source/previous_network_transaction_reference
    • payment_source/card/attributes/vault/confirm_payment_token
    • payment_source/card/attributes/vault/store_in_vault
    • payment_source/paypal/attributes/vault/confirm_payment_token
    • payment_source/paypal/attributes/vault/store_in_vault
    • payment_source/apple_pay/attributes/vault/store_in_vault
    • payment_source/card/number
    • payment_source/card/vault_id
    • payment_source/card/stored_credential
    • payment_source/apple_pay/stored_credential
    • application_context/stored_payment_source
    • payment_source/paypal/vault_id
    • payment_source/venmo/vault_id
    • payment_source/apple_pay/vault_id
    • payment_source/card/attributes/vault
    • payment_source/paypal/attributes/vault
    • payment_source/venmo/attributes/vault
    • payment_source/google_pay/decrypted_token/cryptogram
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/decrypted_token/eci_indicator
    • payment_source/google_pay/token
    • payment_source/google_pay/decrypted_token
    • payment_source/card/paypal_transaction_id
    • payment_source/card/pnref
    • payment_source/paypal/billing_agreement_id
    • payment_source/apple_pay/attributes/vault
    • payment_source/apple_pay/decrypted_token/payment_data/cryptogram
    • /payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
    • /payment_source/card/attributes/payment_origin
  • INVALID_PREVIOUS_TRANSACTION_REFERENCE: The authorization or capture referenced by previous_transaction_reference is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid previous_transaction_reference.
  • PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK: The capture referenced by previous_transaction_reference has a chargeback and hence cannot be used for this order. Please use a previous_transaction_reference which does not have a chargeback.
  • PREVIOUS_TRANSACTION_REFERENCE_VOIDED: The status of authorization referenced by previous_transaction_reference is VOIDED and hence cannot be used for this order. Please use a previous_transaction_reference whose status is not VOIDED.
  • PAYMENT_SOURCE_MISMATCH: The payment_source in the request must match the payment_source used for the authorization or capture referenced by previous_transaction_reference. Please use previous_transaction_reference whose payment_source matches with the payment_source specified in the order.
  • MERCHANT_INITIATED_WITH_SECURITY_CODE: stored_payment_source.payment_initiator = MERCHANT is not supported if payment_source.card.security_code is present in the order. security_code can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with security_code is the order.
  • MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS: stored_payment_source.payment_initiator = MERCHANT is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order.
  • MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS: stored_payment_source.payment_initiator = MERCHANT is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit).
  • RETURN_URL_REQUIRED: The return url is required when attempting to vault this source.
  • CANCEL_URL_REQUIRED: The cancel url is required when attempting to vault this source.
  • PAYER_ACTION_REQUIRED: Transaction cannot complete successfully, instruct the buyer to return to PayPal.
  • APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
  • CARD_NUMBER_REQUIRED: The card number is required when attempting to process payment with card.
     Possible error locations:
    • payment_source/card/number
  • CARD_EXPIRY_REQUIRED: The card expiry is required when attempting to process payment with card.
     Possible error locations:
    • payment_source/card/expiry
  • VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
  • MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact account manager to enable the functionality.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
     Possible error locations:
    • payment_source/venmo/vault_id
    • payment_source/card/vault_id
    • payment_source/paypal/vault_id
    • payment_source/apple_pay/vault_id
  • ORDER_CANNOT_BE_SAVED: The option to save an order is only available if the intent is AUTHORIZE and processing_instruction uses one of the ORDER_SAVED options. For example, intent=AUTHORIZE, processing_instruction=ORDER_SAVED_EXPLICITLY. Please change the intent and/or processing_instruction` and try again.
  • SAVE_ORDER_NOT_SUPPORTED: The API caller account is setup in a way that does not allow it to be used for saving the order. This functionality is not available for PayPal Complete Payments Platform for Platforms & Marketplaces.
  • NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
  • NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
  • PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
  • PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
  • INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
     Possible error locations:
    • payment_source/card/security_code
  • REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/transaction_amount
    • /payment_source/apple_pay/decrypted_token/payment_data
    • /payment_source/apple_pay/decrypted_token/payment_data_type
    • /payment_source/apple_pay/decrypted_token/device_manufacturer_id
  • INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
     Possible error locations:
    • /payment_source/paypal/vault_id

Capture order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
RESOURCE_CONFLICT
The server has detected a conflict while processing this request.
  • PREVIOUS_REQUEST_IN_PROGRESS: A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
  • INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
  • INVALID_PARAMETER_VALUE: A parameter value is not valid.
     Possible error locations:
    • intent
    • Prefer
    • payment_source/token/type
  • MISSING_REQUIRED_PARAMETER: A required field / parameter is missing
     Possible error locations:
    • payment_source/token/id
    • payment_source/token/type
    • /payment_source/paypal/attributes/vault/confirm_payment_token
    • /payment_source/paypal/attributes/vault/usage_type
    • /payment_source/card/attributes/vault/confirm_payment_token
    • /payment_source/card/network_token/number
    • /payment_source/card/network_token/expiry
    • /payment_source/paypal/attributes/vault/owner_id
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long
     Possible error locations:
    • payment_source/token/id
    • /payment_source/paypal/attributes/customer/id
    • /payment_source/apple_pay/attributes/customer/id
  • INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/usage_type
    • /payment_source/paypal/attributes/vault/customer_type
    • /payment_source/paypal/attributes/vault/confirm_payment_token
    • /payment_source/paypal/attributes/customer/id
    • /payment_source/card/attributes/customer/id
    • /payment_source/apple_pay/attributes/customer/id
    • /payment_source/card/attributes/vault/confirm_payment_token
    • /payment_source/paypal/payment_method_preference
  • MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • CONSENT_NEEDED: CONSENT_NEEDED
  • NOT_ELIGIBLE_FOR_TOKEN_PROCESSING: API caller is not enabled to process payments with the specified type of token. Please contact customer support to request permissions to process transactions with this type of token.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
  • PERMISSION_DENIED_FOR_DONATION_ITEMS: The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
RESOURCE_NOT_FOUND
The specified resource does not exist.
  • INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
  • AGREEMENT_ALREADY_CANCELLED: The requested agreement is already canceled.
  • PREFERRED_BRAND_NOT_SUPPORTED: Processing of this preferred brand is not supported. Please use another brand preference to continue with this transaction.
  • BILLING_AGREEMENT_NOT_FOUND: The requested Billing Agreement token was not found.
  • DECLINED_DUE_TO_RELATED_TXN: One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed.
  • MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
  • MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
  • CARD_BRAND_NOT_SUPPORTED: Processing of this card brand is not supported. Please use another card to continue with this transaction.
  • CARD_COUNTRY_NOT_SUPPORTED: The country in which this card was issued is not currently supported. Please use another card to continue with this transaction.
     Possible error locations:
    • /payment_source/card/billing_address/country_code
  • CARD_DATA_NOT_FOUND: The card issuer data information could not be retrieved. Please use a different card to proceed with this transaction.
     Possible error locations:
    • /payment_source/card/number
  • COMPLIANCE_VIOLATION: Transaction is declined due to compliance violation.
  • DOMESTIC_TRANSACTION_REQUIRED: This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
  • DUPLICATE_INVOICE_ID: Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
  • INSTRUMENT_DECLINED: The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
  • ORDER_NOT_APPROVED: Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call or provide a valid payment_source in the request.
  • MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED: You have exceeded the maximum number of payment attempts.
  • PAYEE_BLOCKED_TRANSACTION: Declined by fraud tool (Fraud Protection/Chargeback Protection) due to potential fraud risk. Please review your fraud settings.
  • CONTINGENCY_NOT_SUCCESSFUL: 3D-Secure payer authentication is unsuccessful, so the payment cannot be completed.
  • PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
  • PAYER_ACCOUNT_LOCKED_OR_CLOSED: The payer account cannot be used for this transaction.
  • PAYER_ACCOUNT_RESTRICTED: PAYER_ACCOUNT_RESTRICTED
  • PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
  • PAYER_CANNOT_PAY: Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
  • PAYPAL_TRANSACTION_ID_EXPIRED: Specified paypal_transaction_id has expired. PayPal transaction ID expires 4 years after the date of the initial transaction.
  • PNREF_EXPIRED: Specified pnref has expired. PNREF expires 15 months after the date of the initial transaction.
  • PAYMENT_DENIED: PayPal has declined to process this transaction.
  • REFERENCED_CARD_EXPIRED: The card underlying the token has expired and hence cannot be used to process a payment.
  • TOKEN_ID_NOT_FOUND: Specified token was not found. Verify the token and try the request again.
  • TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
  • TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the receiver's receiving limit.
  • TRANSACTION_REFUSED: The request was refused.
  • REDIRECT_PAYER_FOR_ALTERNATE_FUNDING: Transaction failed. Redirect the payer to select another funding source.
  • ORDER_ALREADY_CAPTURED: Order already captured.If 'intent=CAPTURE' only one capture per order is allowed.
  • TRANSACTION_BLOCKED_BY_PAYEE: Transaction blocked by Payee’s Fraud Protection settings.
  • AUTH_CAPTURE_NOT_ENABLED: Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
  • NOT_ENABLED_FOR_BANK_PROCESSING: The API Caller account is not setup to be able to process bank payments. Please contact your PayPal account manager.
  • NOT_ENABLED_FOR_CARD_PROCESSING: The API Caller account is not setup to be able to process card payments. Please contact PayPal customer support.
  • PAYEE_NOT_ENABLED_FOR_BANK_PROCESSING: Payee account is not setup to be able to process bank payments. Please contact your PayPal account manager.
  • PAYEE_NOT_ENABLED_FOR_CARD_PROCESSING: Payee account is not setup to be able to process card payments. Please contact PayPal customer support.
  • INVALID_PICKUP_ADDRESS: If the 'shipping_option.type' is set as 'PICKUP' then the 'shipping_detail.name.full_name' should start with 'S2S' meaning Ship To Store. Example: 'S2S My Store'.
  • SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
  • PAYMENT_SOURCE_NOT_SUPPORTED: The payer selected method of payment is not supported when multiple purchase units are specified for an Order.
  • INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
  • ORDER_COMPLETION_IN_PROGRESS: The order was created with processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL. The customer has approved the payment and PayPal is still in the process of capturing the order on your behalf as instructed. Please try your request again.
  • BILLING_AGREEMENT_ID_MISMATCH: Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation.
  • PREFERRED_PAYMENT_SOURCE_MISMATCH: Payment Source must exactly match the Preferred Payment Source that was provided during order creation.
  • INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
     Possible error locations:
    • application_context/stored_payment_source/payment_initiator
    • application_context/stored_payment_source/payment_type
    • application_context/stored_payment_source/usage
    • application_context/stored_payment_source/previous_transaction_reference
    • application_context/stored_payment_source/previous_network_transaction_reference
    • payment_source/card/attributes/vault/confirm_payment_token
    • payment_source/card/attributes/vault/store_in_vault
    • payment_source/paypal/attributes/vault/confirm_payment_token
    • payment_source/paypal/attributes/vault/store_in_vault
    • payment_source/apple_pay/attributes/vault/store_in_vault
    • payment_source/card/number
    • payment_source/card/vault_id
    • payment_source/card/stored_credential
    • payment_source/apple_pay/stored_credential
    • application_context/stored_payment_source
    • payment_source/paypal/vault_id
    • payment_source/venmo/vault_id
    • payment_source/apple_pay/vault_id
    • payment_source/card/attributes/vault
    • payment_source/paypal/attributes/vault
    • payment_source/venmo/attributes/vault
    • payment_source/card/paypal_transaction_id
    • payment_source/card/pnref
    • payment_source/paypal/billing_agreement_id
    • payment_source/apple_pay/attributes/vault
    • payment_source/apple_pay/decrypted_token/payment_data/cryptogram
    • /payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
    • /payment_source/card/attributes/payment_origin
    • payment_source/bank/ach_debit/account_number
    • payment_source/bank/ach_debit/routing_number
    • payment_source/bank/ach_debit/account_type
    • payment_source/bank/ach_debit/account_holder_name
    • payment_source/bank/ach_debit/vault_id
    • payment_source/bank/ach_debit/attributes/vault
    • payment_source/bank/ach_debit/stored_credential
  • INVALID_PREVIOUS_TRANSACTION_REFERENCE: The authorization or capture referenced by previous_transaction_reference is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid previous_transaction_reference.
  • PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK: The capture referenced by previous_transaction_reference has a chargeback and hence cannot be used for this order. Please use a previous_transaction_reference which does not have a chargeback.
  • PREVIOUS_TRANSACTION_REFERENCE_VOIDED: The status of authorization referenced by previous_transaction_reference is VOIDED and hence cannot be used for this order. Please use a previous_transaction_reference whose status is not VOIDED.
  • PAYMENT_SOURCE_MISMATCH: The payment_source in the request must match the payment_source used for the authorization or capture referenced by previous_transaction_reference. Please use previous_transaction_reference whose payment_source matches with the payment_source specified in the order.
  • MERCHANT_INITIATED_WITH_SECURITY_CODE: stored_payment_source.payment_initiator = MERCHANT is not supported if payment_source.card.security_code is present in the order. security_code can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with security_code is the order.
  • MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS: stored_payment_source.payment_initiator = MERCHANT is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order.
  • MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS: stored_payment_source.payment_initiator = MERCHANT is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit).
  • RETURN_URL_REQUIRED: The return url is required when attempting to vault this source.
  • CANCEL_URL_REQUIRED: The cancel url is required when attempting to vault this source.
  • SETUP_ERROR_FOR_BANK: The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager.
  • BANK_NOT_SUPPORTED_FOR_VERIFICATION: Verification for this bank account is not supported.
  • PAYER_ACTION_REQUIRED: Transaction cannot complete successfully, instruct the buyer to return to PayPal.
  • APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
  • CURRENCY_NOT_SUPPORTED_FOR_BANK: The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported.
  • ONLY_ONE_BANK_SOURCE_ALLOWED: More than one payment method within the bank payment object is not supported.
  • INVALID_IBAN: IBAN provided is not a valid bank account number.
  • IBAN_COUNTRY_NOT_SUPPORTED: Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments.
  • CARD_NUMBER_REQUIRED: The card number is required when attempting to process payment with card.
     Possible error locations:
    • payment_source/card/number
  • CARD_EXPIRY_REQUIRED: The card expiry is required when attempting to process payment with card.
     Possible error locations:
    • payment_source/card/expiry
  • VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
  • MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
     Possible error locations:
    • payment_source/venmo/vault_id
    • payment_source/card/vault_id
    • payment_source/paypal/vault_id
    • payment_source/apple_pay/vault_id
  • MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact account manager to enable the functionality.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
  • NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
  • PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
  • PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
  • INVALID_VAULT_SETUP_TOKEN: The specified Vault Setup Token is invalid or could not be found.
     Possible error locations:
    • /payment_source/paypal/vault_setup_token
    • /payment_source/card/vault_setup_token
  • INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
     Possible error locations:
    • payment_source/card/security_code
  • PLATFORM_FEE_PAYEE_CANNOT_BE_SAME_AS_PAYER: The payer cannot pay themselves. The recipient account of the platform fees must be different from the payer account.
  • REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/transaction_amount
    • /payment_source/apple_pay/decrypted_token/payment_data
    • /payment_source/apple_pay/decrypted_token/payment_data_type
    • /payment_source/apple_pay/decrypted_token/device_manufacturer_id
  • IDENTIFIER_NOT_FOUND: Specified identifier was not found. Please verify the correct identifier was used and try the request again.
  • INCOMPATIBLE_ACCOUNT_OWNERSHIP_TYPE: Account ownership type is not compatible with standard entry class code.
  • COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Country code provided is not supported by the provided payment source.
     Possible error locations:
    • /payment_source/ach_debit/billing_address/country_code
  • LOCALE_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Locale provided is not supported by the provided payment source.
     Possible error locations:
    • /payment_source/ach_debit/experience_context/locale
  • BANK_VERIFICATION_REQUIRED: Only verified bank accounts can be processed.
     Possible error locations:
    • /payment_source/ach_debit/attributes/verification
  • INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
     Possible error locations:
    • /payment_source/paypal/vault_id
  • NOT_ENABLED_FOR_PAYMENT_SOURCE: The 'API caller' and/or 'payee' is not setup to be able to process the selected payment source. If you have already completed the required steps, please allow 2 business days for PayPal to complete the setup. If you continue to receive this error, please contact your Account Manager or check status at https://www.paypal.com/businessmanage/account/payments.
     Possible error locations:
    • /payment_source/alipay
    • /payment_source/bancomatpay
    • /payment_source/bancontact
    • /payment_source/blik
    • /payment_source/boletobancario
    • /payment_source/eps
    • /payment_source/giropay
    • /payment_source/ideal
    • /payment_source/mbway
    • /payment_source/multibanco
    • /payment_source/mybank
    • /payment_source/oxxo
    • /payment_source/payu
    • /payment_source/p24
    • /payment_source/paidy
    • /payment_source/safetypay
    • /payment_source/satispay
    • /payment_source/trustly
    • /payment_source/wechatpay
  • AUTO_CAPTURE_ENABLED: This order is being auto-captured. Merchant initiated capture requests are not allowed.

Confirm order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
  • INVALID_PARAMETER_SYNTAX: The value of the field does not conform to the expected format.
     Possible error locations:
    • /payment_source/card/billing_address/country_code
    • /payment_source/card/expiry
    • /payment_source/card/security_code
    • /payment_source/paypal/attributes/vault/usage_type
    • /payment_source/paypal/attributes/vault/customer_type
    • /payment_source/paypal/attributes/vault/confirm_payment_token
    • /payment_source/paypal/attributes/customer/id
    • /payment_source/card/attributes/customer/id
    • /payment_source/apple_pay/attributes/customer/id
    • /payment_source/card/attributes/vault/confirm_payment_token
    • /payment_source/paypal/payment_method_preference
    • payment_source/google_pay/decrypted_token/eci_indicator
  • INVALID_PARAMETER_VALUE: A parameter value is not valid.
     Possible error locations:
    • Prefer
    • payment_source/google_pay/decrypted_token/payment_method
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/decrypted_token/message_id
    • payment_source/google_pay/decrypted_token/message_expiration
  • MISSING_REQUIRED_PARAMETER: A required field / parameter is missing
     Possible error locations:
    • /payment_source
    • /payment_source/card/number
    • /payment_source/card/expiry
    • /payment_source/card/billing_address/country_code
    • /payment_source/alipay/country_code
    • /payment_source/alipay/name
    • /payment_source/bancomatpay/country_code
    • /payment_source/bancomatpay/phone
    • /payment_source/bancomatpay/phone/national_number
    • /payment_source/bancomatpay/phone/country_code
    • /payment_source/bancomatpay/name
    • /payment_source/bancontact/country_code
    • /payment_source/bancontact/name
    • /payment_source/bancontact/attributes/mandate
    • /payment_source/bancontact/attributes/mandate/type
    • /payment_source/bancontact/attributes/customer
    • /payment_source/bancontact/attributes/customer/id
    • /payment_source/blik/country_code
    • /payment_source/blik/name
    • /payment_source/boletobancario/country_code
    • /payment_source/boletobancario/name
    • /payment_source/boletobancario/email
    • /payment_source/boletobancario/tax_info/tax_id
    • /payment_source/boletobancario/tax_info/tax_id_type
    • /payment_source/boletobancario/billing_address/address_line_1
    • /payment_source/boletobancario/billing_address/address_line_2
    • /payment_source/boletobancario/billing_address/admin_area_1
    • /payment_source/boletobancario/billing_address/admin_area_2
    • /payment_source/boletobancario/billing_address/postal_code
    • /payment_source/eps/country_code
    • /payment_source/eps/name
    • /payment_source/giropay/country_code
    • /payment_source/giropay/name
    • /payment_source/ideal/country_code
    • /payment_source/ideal/name
    • /payment_source/ideal/attributes/mandate
    • /payment_source/ideal/attributes/mandate/type
    • /payment_source/ideal/attributes/customer
    • /payment_source/ideal/attributes/customer/id
    • /payment_source/mbway/country_code
    • /payment_source/mbway/phone
    • /payment_source/mbway/phone/national_number
    • /payment_source/mbway/phone/country_code
    • /payment_source/mbway/name
    • /payment_source/mybank/country_code
    • /payment_source/mybank/name
    • /payment_source/oxxo/country_code
    • /payment_source/oxxo/name
    • /payment_source/oxxo/email
    • /payment_source/payu/country_code
    • /payment_source/payu/name
    • /payment_source/p24/country_code
    • /payment_source/p24/name
    • /payment_source/p24/email
    • /payment_source/sofort/country_code
    • /payment_source/sofort/name
    • /payment_source/trustly/country_code
    • /payment_source/trustly/name
    • /payment_source/trustly/email
    • /payment_source/verkkopankki/country_code
    • /payment_source/verkkopankki/name
    • /payment_source/verkkopankki/email
    • /payment_source/wechatpay/country_code
    • /payment_source/wechatpay/name
    • /payment_source/card/billing_address/country_code
    • /payment_source/paypal/attributes/vault/usage_type
    • /payment_source/card/attributes/vault/confirm_payment_token
    • payment_source/google_pay/decrypted_token/card
    • payment_source/google_pay/decrypted_token/card/number
    • payment_source/google_pay/decrypted_token/card/expiry
    • /payment_source/card/network_token/number
    • /payment_source/card/network_token/expiry
    • /payment_source/paypal/attributes/vault/owner_id
    • /payment_source/bank/sepa_debit/attributes/vault/store_in_vault
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long
     Possible error locations:
    • /payment_source/card/billing_address/country_code
    • /payment_source/google_pay/decrypted_token/message_expiration
    • /payment_source/google_pay/decrypted_token/authentication_method
    • /payment_source/google_pay/decrypted_token/cryptogram
    • /payment_source/google_pay/decrypted_token/eci_indicator
  • INVALID_STRING_MAX_LENGTH: The value of a field is too long.
     Possible error locations:
    • /payment_source/card/name
    • /payment_source/card/billing_address/address_line_1
    • /payment_source/card/billing_address/address_line_2
    • /payment_source/card/billing_address/admin_area_1
    • /payment_source/card/billing_address/admin_area_2
    • /payment_source/card/billing_address/postal_code
    • /payment_source/paypal/attributes/customer/id
    • /payment_source/apple_pay/attributes/customer/id
  • MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
  • NOT_ENABLED_FOR_CARD_PROCESSING: The recipient for which the API call is made on behalf of is not enabled for card processing. Please contact PayPal customer support.
  • PAYEE_ACCOUNT_NOT_VERIFIED: Payee has not verified their account with PayPal. The selected payment method requires the recipient to have a verified PayPal account before transactions can be processed on their behalf.
RESOURCE_NOT_FOUND
The specified resource does not exist.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
  • ORDER_ALREADY_CAPTURED: Order already captured. If 'intent=CAPTURE' only one capture per order is allowed.
  • ORDER_ALREADY_AUTHORIZED: Order already captured. If 'intent=CAPTURE' only one capture per order is allowed.
  • ORDER_CANNOT_BE_CONFIRMED: An order with status = 'COMPLETED' cannot be confirmed again.
  • MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
  • MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
  • CURRENCY_NOT_SUPPORTED_FOR_COUNTRY:  For the payment_source specified, the currency of the Order is restricted by the country in which the payee account is based. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
  • CARD_EXPIRED: The card is expired
  • CARD_TYPE_NOT_SUPPORTED: Processing of this card type is not supported. Use another card type.
  • CURRENCY_NOT_SUPPORTED_FOR_CARD_TYPE: The issued currency code of this card is not supported for direct card payments. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
  • CARD_COUNTRY_NOT_SUPPORTED: The country in which this card was issued is not currently supported. Please use another card to continue with this transaction.
     Possible error locations:
    • /payment_source/card/billing_address/country_code
  • CARD_DATA_NOT_FOUND: The card issuer data information could not be retrieved. Please use a different card to proceed with this transaction.
     Possible error locations:
    • /payment_source/card/number
  • ONLY_ONE_PAYMENT_SOURCE_ALLOWED: More than one payment method within the payment source is not supported.
     Possible error locations:
    • /payment_source
  • NO_PAYMENT_SOURCE_PROVIDED: At least one payment method is required within the payment source.
     Possible error locations:
    • /payment_source
  • PAYMENT_ALREADY_APPROVED: The payment has already been approved. Please capture the order, or create and confirm a new order with this payment source.
  • PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
  • UNSUPPORTED_PROCESSING_INSTRUCTION: The specified processing_instruction is not supported for the given payment_source. Please refer to https://developer.paypal.com/api/orders/v2/#definition-processing_instruction for the list of payment_source that can be specified with this value.
  • INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
  • ORDER_COMPLETE_ON_PAYMENT_APPROVAL: A processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL is required for the specified payment_source.
  • INVALID_EXPIRY_DATE: Expiry date is invalid. Expiry date should be a date in future and within the threshold for the payment source.
     Possible error locations:
    • payment_source/oxxo/expiry_date
    • payment_source/boletobancario/expiry_date
  • TOKEN_EXPIRED: The token is expired and cannot be used for payment.
     Possible error locations:
    • payment_source/google_pay/decrypted_token/message_expiration
    • payment_source/google_pay/token
  • INVALID_GOOGLE_PAY_TOKEN: The google pay token is invalid. PayPal was not able to decrypt the googlepay token or PayPal was not able to find the necessary data in the token after decryption.
     Possible error locations:
    • /payment_source/google_pay/token
  • GOOGLE_PAY_GATEWAY_MERCHANT_ID_MISMATCH: The gateway merchant ID in Google Pay token is not valid. This could be because the gateway merchant Id that was authorized by payer/buyer on Google Pay does not match with the API caller of the order.
     Possible error locations:
    • /payment_source/google_pay/token
  • CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
     Possible error locations:
    • /payment_source/google_pay/decrypted_token/cryptogram
  • ONE_OF_PARAMETERS_REQUIRED: One or more field is required to continue with this request.
     Possible error locations:
    • /payment_source/google_pay/token
    • /payment_source/google_pay/decrypted_token
  • RETURN_URL_REQUIRED: The return url is required when attempting to vault this source.
  • CANCEL_URL_REQUIRED: The cancel url is required when attempting to vault this source.
  • COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Country code provided is not supported by the provided payment source.
     Possible error locations:
    • /payment_source/pay_upon_invoice/billing_address/country_code
    • /payment_source/bancomatpay/country_code
    • /payment_source/bancomatpay/phone/country_code
    • /payment_source/mbway/country_code
    • /payment_source/mbway/phone/country_code
    • /payment_source/ach_debit/billing_address/country_code
  • REQUIRED_PARAMETER_FOR_PAYMENT_SOURCE: The parameter is required for provided payment source.
     Possible error locations:
    • /payment_source/pay_upon_invoice/name
    • /payment_source/pay_upon_invoice/name/given_name
    • /payment_source/pay_upon_invoice/name/surname
    • /payment_source/pay_upon_invoice/birth_date
    • /payment_source/pay_upon_invoice/email
    • /payment_source/pay_upon_invoice/phone
    • /payment_source/pay_upon_invoice/phone/national_number
    • /payment_source/pay_upon_invoice/phone/country_code
    • /payment_source/pay_upon_invoice/billing_address
    • /payment_source/pay_upon_invoice/billing_address/address_line_1
    • /payment_source/pay_upon_invoice/billing_address/admin_area_2
    • /payment_source/pay_upon_invoice/billing_address/postal_code
    • /payment_source/pay_upon_invoice/billing_address/country_code
  • REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/transaction_amount
    • /payment_source/apple_pay/decrypted_token/payment_data
    • /payment_source/apple_pay/decrypted_token/payment_data_type
    • /payment_source/apple_pay/decrypted_token/device_manufacturer_id
  • ITEM_CATEGORY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: The provided payment source does not support provided item category.
     Possible error locations:
    • /purchase_units/0/items/0/category
  • PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED: The combination of the payment_source name, billing address, shipping name and shipping address could not be verified. Please correct this information and try again by creating a new order.
  • PAYMENT_SOURCE_DECLINED_BY_PROCESSOR: The provided payment source is declined by the processor. Please try again with a different payment source by creating a new order.
  • PAYMENT_SOURCE_CANNOT_BE_USED: The provided payment source cannot be used to pay for the order. Please try again with a different payment source by creating a new order.
  • SETUP_ERROR_FOR_BANK: The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager.
  • BANK_NOT_SUPPORTED_FOR_VERIFICATION: Verification for this bank account is not supported.
  • APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
  • ONE_OF_THE_PARAMETERS_REQUIRED: One or more field is required to continue with this request.
  • BILLING_ADDRESS_INVALID: Provided billing address is invalid.
     Possible error locations:
    • /payment_source/pay_upon_invoice/billing_address
  • SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
  • ORDER_IS_PENDING_APPROVAL: The order was confirmed and payer action completed but order approval processing from PayPal is pending. No action is needed from Payee or Payer. Please wait until order status changes to 'APPROVED'.
  • DEVICE_DATA_NOT_AVAILABLE: Device Data is not available for processing this order. The PayPal-Client-Metadata-Id header value sent during Create Order api call is either missing or incorrect or there was an error in collecting required data. Please verify if appropriate value for PayPal-Client-Metadata-Id header is being sent during 'Create Order' api call. Please note this error only applies to payment_source.pay_upon_invoice at the moment.
  • CURRENCY_NOT_SUPPORTED_FOR_BANK: The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported.
  • ONLY_ONE_BANK_SOURCE_ALLOWED: More than one payment method within the bank payment object is not supported.
  • INVALID_IBAN: IBAN provided is not a valid bank account number.
  • IBAN_COUNTRY_NOT_SUPPORTED: Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments.
  • PAYEE_COUNTRY_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: Payee country code is not supported by the provided payment source.
  • CARD_NUMBER_REQUIRED: The card number is required when attempting to process payment with card.
     Possible error locations:
    • payment_source/card/number
  • CARD_EXPIRY_REQUIRED: The card expiry is required when attempting to process payment with card.
     Possible error locations:
    • payment_source/card/expiry
  • INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
     Possible error locations:
    • payment_source/paypal/experience_context/brand_name
    • payment_source/paypal/experience_context/locale
    • payment_source/paypal/experience_context/return_url
    • payment_source/paypal/experience_context/cancel_url
    • application_context/brand_name
    • application_context/locale
    • application_context/return_url
    • application_context/cancel_url
    • payment_source/google_pay/decrypted_token/cryptogram
    • payment_source/google_pay/decrypted_token/authentication_method
    • payment_source/google_pay/decrypted_token/eci_indicator
    • payment_source/google_pay/token
    • payment_source/google_pay/decrypted_token
    • payment_source/google_pay/decrypted_token/cryptogram
    • payment_source/card/attributes/vault/confirm_payment_token
    • payment_source/card/attributes/vault/store_in_vault
    • payment_source/paypal/attributes/vault/confirm_payment_token
    • payment_source/paypal/attributes/vault/store_in_vault
    • payment_source/apple_pay/attributes/vault/store_in_vault
    • payment_source/paypal/experience_context/brand_name
    • payment_source/paypal/experience_context/locale
    • payment_source/paypal/experience_context/return_url
    • payment_source/paypal/experience_context/cancel_url
    • application_context/brand_name
    • application_context/locale
    • application_context/return_url
    • application_context/cancel_url
    • payment_source/paypal/vault_id
    • payment_source/card/number
    • payment_source/card/vault_id
    • payment_source/venmo/vault_id
    • payment_source/card/attributes/vault
    • payment_source/paypal/attributes/vault
    • payment_source/venmo/attributes/vault
    • payment_source/card/paypal_transaction_id
    • payment_source/card/pnref
    • payment_source/paypal/billing_agreement_id
    • payment_source/apple_pay/vault_id
    • payment_source/apple_pay/attributes/vault
    • payment_source/apple_pay/decrypted_token/payment_data/cryptogram
    • /payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
    • /payment_source/card/attributes/payment_origin
    • payment_source/bank/sepa_debit/stored_credential/payment_initiator
    • payment_source/bank/sepa_debit/stored_credential/payment_type
    • payment_source/bank/sepa_debit/vault_id
    • payment_source/bank/sepa_debit/iban
    • payment_source/bank/sepa_debit/account_holder_name
    • payment_source/bank/sepa_debit/billing_address
    • payment_source/bank/sepa_debit/attributes/mandate/type
    • payment_source/bank/sepa_debit/stored_credential/payment_type
  • VAULT_INSTRUCTION_DUPLICATED: Only one vault instruction is allowed. Please use vault.store_in_vault to provide vault instruction.
  • VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
  • MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact account manager to enable the functionality.
     Possible error locations:
    • /payment_source/paypal/attributes/vault/owner_id
  • MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
     Possible error locations:
    • payment_source/venmo/vault_id
    • payment_source/card/vault_id
    • payment_source/paypal/vault_id
    • payment_source/apple_pay/vault_id
    • payment_source/bank/sepa_debit/vault_id
  • NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
  • NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
  • PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
  • PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
  • INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
     Possible error locations:
    • payment_source/card/security_code
  • NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE: The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance.
  • CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/payment_data/cryptogram
  • EMV_DATA_REQUIRED: EMV Data is required if authentication method is EMV.
     Possible error locations:
    • /payment_source/apple_pay/decrypted_token/payment_data/emv_data
  • ALIAS_DECLINED_BY_PROCESSOR: The provided alias was declined by the processor. Please create a new order with a different alias_key and/or alias_label and try again.
  • BLIK_ONE_CLICK_MISSING_REQUIRED_PARAMETER: Blik's one_click flow requires one_click.auth_code and one_click.alias_label parameters for the buyer's first transaction. For all subsequent transactions,only the one_click.alias_key parameter is required.
     Possible error locations:
    • payment_source/blik/one_click/auth_code
    • payment_source/blik/one_click/alias_label
    • payment_source/blik/one_click/alias_key
  • TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
  • PUI_DUPLICATE_ORDER: A Pay Upon Invoice (Rechnungskauf) order with the same payload has already been successfully processed in the last few seconds. To process a new order, please try again in a few seconds.
  • NOT_ENABLED_FOR_PAYMENT_SOURCE: The 'API caller' and/or 'payee' is not setup to be able to process the selected payment source. If you have already completed the required steps, please allow 2 business days for PayPal to complete the setup. If you continue to receive this error, please contact your Account Manager or check status at https://www.paypal.com/businessmanage/account/payments.
     Possible error locations:
    • /payment_source/alipay
    • /payment_source/bancomatpay
    • /payment_source/bancontact
    • /payment_source/blik
    • /payment_source/boletobancario
    • /payment_source/eps
    • /payment_source/giropay
    • /payment_source/ideal
    • /payment_source/mbway
    • /payment_source/multibanco
    • /payment_source/mybank
    • /payment_source/oxxo
    • /payment_source/payu
    • /payment_source/p24
    • /payment_source/paidy
    • /payment_source/safetypay
    • /payment_source/satispay
    • /payment_source/trustly
    • /payment_source/wechatpay
  • INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
     Possible error locations:
    • /payment_source/paypal/vault_id
  • MULTIPLE_PURCHASE_UNITS_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: The provided payment source cannot be used to pay for the multiple purchase units order.
     Possible error locations:
    • /payment_source/alipay
    • /payment_source/bancomatpay
    • /payment_source/bancontact
    • /payment_source/blik
    • /payment_source/eps
    • /payment_source/ideal
    • /payment_source/mbway
    • /payment_source/mybank
    • /payment_source/oxxo
    • /payment_source/payu
    • /payment_source/p24
    • /payment_source/trustly
    • /payment_source/wechatpay
    • /payment_source/grabpay
    • /payment_source/multibanco
    • /payment_source/satispay
    • /payment_source/pay_upon_invoice
  • LOCALE_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Locale provided is not supported by the provided payment source.
     Possible error locations:
    • /payment_source/ach_debit/experience_context/locale
  • BANK_VERIFICATION_REQUIRED: Only verified bank accounts can be processed.
     Possible error locations:
    • /payment_source/ach_debit/attributes/verification
FEE_REFERENCE_ID_NOT_FOUND
fee_reference_id is invalid or not found. Possible error locations:
  • /payment_source/card/attributes/installments/fee_reference_id
FEE_REFERENCE_AMOUNT_MISMATCH
Mismatch of amount used to for financing offer and order amount. Pass new amount to get financing offer & pass new fee_reference_id. Possible error locations:
  • /payment_source/card/attributes/installments/fee_reference_id
UNSUPPORTED_INSTALLMENTS
Installments are not supported for this payee, payment_source, amount and currency combination. Possible error locations:
  • /payment_source/card/attributes/installments
UNSUPPORTED_INSTALLMENT_TERM
Unsupported installment term. Issuer does not have support for this installment term. Possible error locations:
  • /payment_source/card/attributes/installments/term
UNSUPPORTED_INSTALLMENT_INTERVAL_DURATION
Unsupported installment interval duration. Only interval duration 'P1M' is supported. Possible error locations:
  • /payment_source/card/attributes/installments/interval_duration
UNSUPPORTED_INTENT_FOR_INSTALLMENTS
‘intent=AUTHORIZE` is not supported for installments. Only 'intent=CAPTURE' is supported. Possible error locations:
  • /intent
UNSUPPORTED_PAYMENT_SOURCE_FOR_INSTALLMENTS
Installments are not supported for this payment_source. Possible error locations:
  • /payment_source
UNSUPPORTED_INSTALLMENTS_FOR_MULTIPLE_PURCHASE_UNITS
Issuer installments are not supported for multiple purchase units. Possible error locations:
  • /purchase_units

Save order

Error Description Issue
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
  • ORDER_CANNOT_BE_SAVED: The option to save an order is only available if the intent is AUTHORIZE and processing_instruction uses one of the ORDER_SAVED options. For example, intent=AUTHORIZE, processing_instruction=ORDER_SAVED_EXPLICITLY. Please change the intent and/or processing_instruction` and try again.
  • SAVE_ORDER_NOT_SUPPORTED: The API caller account is setup in a way that does not allow it to be used for saving the order. This functionality is not available for PayPal Complete Payments Platform for Platforms & Marketplaces.

Track order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well formed, is syntactically incorrect, or violates schema.
  • MISSING_REQUIRED_PARAMETER: A required field / parameter is missing.
     Possible error locations:
    • /tracking_number
    • /capture_id
    • /carrier
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long.
     Possible error locations:
    • /capture_id
    • /tracking_number
    • /carrier_name_other
    • /items/0/name
    • /items/0/image_url
    • /items/0/url
  • INVALID_PARAMETER_VALUE: A parameter value is not valid.
     Possible error locations:
    • /carrier
    • /items/0/upc
  • INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
     Possible error locations:
    • /capture_id
    • /items/0/image_url
    • /items/0/url
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
UNPROCESSABLE_ENTITY
The requested action could not be performed, is semantically incorrect, or failed business validation.
  • CAPTURE_STATUS_NOT_VALID: Invalid capture status. Tracker information can only be added to captures in COMPLETED state.
  • ITEM_SKU_MISMATCH: Item sku must match one of the items sku that was provided during order creation.
     Possible error locations:
    • /items/0/sku
  • CAPTURE_ID_NOT_FOUND: Specified capture ID does not exist. Check the capture ID and try again.
     Possible error locations:
    • /capture_id
  • MSP_NOT_SUPPORTED: Multiple purchase units are not supported for this operation.
RESOURCE_NOT_FOUND
The specified resource does not exist.
  • INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.

Trackers order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well formed, is syntactically incorrect, or violates schema.
  • FIELD_NOT_PATCHABLE: Field cannot be patched.
     Possible error locations:
    • /capture_id
    • /tracking_number
  • INVALID_PARAMETER_VALUE: The value of a field is invalid.
     Possible error locations:
    • op
    • /carrier
  • MISSING_REQUIRED_PARAMETER: A required field or parameter is missing.
     Possible error locations:
    • op
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long.
     Possible error locations:
    • /carrier_name_other
  • INVALID_PATCH_OPERATION: The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add.
     Possible error locations:
    • op
  • MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
RESOURCE_NOT_FOUND
The specified resource does not exist.
  • TRACKER_ID_NOT_FOUND: Specified tracker ID does not exist. Check the tracker ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, is semantically incorrect, or failed business validation.
  • INVALID_JSON_POINTER_FORMAT: Path should be a valid JSON Pointer that references a location within the request where the operation is performed.
  • NOT_PATCHABLE: Cannot be patched.
  • 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.
  • ITEM_SKU_MISMATCH: Item sku must match one of the items sku that was provided during order creation.
     Possible error locations:
    • /items/0/sku
  • MAX_TRACKER_UPDATE_COUNT_EXCEEDED: Exceeding the permissible number of updates; tracker update operations do not support more than 15 updates.

Post order

Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well formed, is syntactically incorrect, or violates schema.
  • INVALID_STRING_LENGTH: The value of a field is either too short or too long.
     Possible error locations:
    • /merchant_id
    • /order_id
    • /session_type
    • /apple_pay/domain_name
    • /apple_pay/display_name
    • /apple_pay/validation_url
  • MISSING_REQUIRED_PARAMETER: A required field or parameter is missing
     Possible error locations:
    • /apple_pay/validation_url
    • /session_type
  • INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
     Possible error locations:
    • /merchant_id
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
  • PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
UNPROCESSABLE_ENTITY
The requested action could not be performed, is semantically incorrect, or failed business validation.
  • NOT_ENABLED_FOR_APPLE_PAY: The 'API caller' and/or 'payee' is not setup to be able to process apple pay. Please contact your Account Manager.
  • DOMAIN_NOT_REGISTERED: The provided domain is not registered for this merchant.
  • TESTING_WITH_REAL_WALLET_NOT_ENABLED: Testing with real wallet is not supported for this domain. To enable testing using real wallet, please unregister the domain and register the domain again.
     Possible error locations:
    • /use_real_wallet
Reference
PayPal.com
Privacy
Support
Legal
Contact