Error handling for API 6.0
Overview
Learn how to tackle the common errors that may arise when using the placeOrder call via 2Checkout API.
Error codes for Order Object
Item: Product
| Error code | Description |
|---|---|
| ORDER_PRODUCTS_EMPTY | No products have been provided. |
| ORDER_PRODUCT_RENEWAL_SUBSCRIPTION_REFERENCE_EMPTY | Subscription reference cannot be empty. |
| ORDER_PRODUCT_RENEWAL_SUBSCRIPTION_REFERENCE_INVALID | Subscription reference is invalid. |
| ORDER_PRODUCT_RENEWAL_SUBSCRIPTION_REFERENCE_NOT_FOUND | Subscription reference is invalid. |
| ORDER_PRODUCT_RENEWAL_PERIOD_INVALID | The renewal period is invalid. |
| ORDER_PRODUCTS_RENEWAL_NOT_ALLOWED | Renewal is not allowed with multiple products. |
| ORDER_PRODUCT_CODE_INVALID | Invalid product code. |
| PRODUCT_ERROR | Invalid product id. |
| ORDER_PRODUCT_CODE_INVALID | Requested product [%s] was not found. |
| ORDER_PRODUCT_PRICE_STRUCTURE_INVALID | The price structure is not valid. |
| ORDER_PRODUCT_PRICE_AMOUNT_INVALID | The price amount is not valid. |
| ORDER_PRODUCT_PRICE_TYPE_INVALID | The price type is not valid |
| ORDER_PRODUCT_PRICE_TYPE_BASE_INVALID | The price amount does not need to be set on the base price flow. |
| ORDER_PRODUCT_PRICE_TYPE_DEFAULT_INVALID | The price amount does not need to be set on the default price flow. |
| ORDER_PRODUCT_PRICE_TYPE_CUSTOM_INVALID | The price amount is mandatory to be set on the custom price flow. |
| ORDER_PRODUCT_INVALID | Internal product validation error. |
| ORDER_PRODUCT_NAME_INVALID | Name is mandatory when you set IsDynamic to TRUE. |
| ORDER_ITEMS_INVALID | Invalid items. You cannot mix dynamic and catalog products. |
| ORDER_PRODUCT_IS_DYNAMIC_INVALID | Invalid IsDynamic value. Use: TRUE or FALSE. |
| ORDER_PRODUCT_PURCHASE_TYPE_INVALID | Invalid product purchase type. Accepted values: PRODUCT, SHIPPING, COUPON and TAX. |
| ORDER_PRODUCT_TANGIBLE_INVALID | Invalid Tangible value. Use: TRUE or FALSE. |
Item: Trial
| Error code | Description |
|---|---|
| INVALID_PRODUCT | Invalid product ID. |
| PRODUCT_ALREADY_IN_CART | Product already in cart. |
| INVALID_TRIAL_PERIOD | The trial period needs to be greater than 0 days. |
| INVALID_TRIAL_PRODUCT | Invalid trial product. |
Item: Cross-sell
| Error code | Description |
|---|---|
| INVALID_CROSS_SELL_PRODUCT | Invalid cross-sell product ID/Invalid cross-sell parent product code/Invalid cross-sell parent product ID/Invalid cross-sell products for specified campaign. |
| PRODUCT_ALREADY_IN_CART | Product already in cart. |
| PRODUCT_NOT_IN_CART | The cross-sell master product is not already in cart. |
| INVALID_CROSS_SELL_CAMPAIGN | Invalid cross-sell campaign. |
Item: Price_options
| Error code | Description |
|---|---|
| INVALID_OPTIONS | Your pricing has error: %s. |
| ORDER_ITEMS_PRICE_OPTIONS_NAME_EMPTY | Item price options name is empty. |
| ORDER_ITEMS_PRICE_OPTIONS_OPTION_NAME_EMPTY | Item price options option name is empty. |
| ORDER_ITEMS_PRICE_OPTIONS_OPTION_VALUE_EMPTY | Item price options option value is empty. |
| ORDER_ITEMS_PRICE_OPTIONS_NAME_INVALID | Invalid item price options name. |
| ORDER_ITEMS_PRICE_OPTIONS_INVALID | Invalid item price options. |
| ORDER_ITEMS_PRICE_OPTIONS_OPTION_NAME_INVALID | Invalid item price options option name. |
| ORDER_ITEMS_PRICE_OPTIONS_OPTION_VALUE_INVALID | Invalid item price options option value. |
| ORDER_ITEMS_PRICE_OPTIONS_OPTION_SURCHARGE_INVALID | Invalid item price options option surcharge. |
Item: Price
| Error code | Description |
|---|---|
| PRICE_ERROR | The price needs to be a decimal value. |
| PRODUCT_ERROR | You need to add the product to the order before setting the price./Invalid product id. |
| CURRENCY_ERROR | No currency is set for the current session. |
| ORDER_ITEMS_RECURRING_OPTIONS_CYCLE_UNIT_INVALID | Invalid item recurring option cycle unit. Accepted values: DAY,WEEK, MONTH, YEAR. |
| ORDER_ITEMS_RECURRING_OPTIONS_CYCLE_LENGTH_INVALID | Invalid item recurring option cycle length. Use integers. |
| ORDER_ITEMS_RECURRING_OPTIONS_CONTRACT_UNIT_INVALID | Invalid item recurring option contract unit. Accepted values: DAY,WEEK, MONTH, YEAR, FOREVER. |
| ORDER_ITEMS_RECURRING_OPTIONS_CONTRACT_LENGTH_INVALID | Invalid item recurring option contract length. Use integers. |
| ORDER_ITEMS_RECURRING_OPTIONS_CYCLE_AMOUNT_INVALID | Item recurring option cycle amount must be zero or a positive value (INT or FLOAT). |
Item: Refund
| Error code | Description |
|---|---|
| ORDER_REFUND_ORDER_REF_MISSING | ORDER_REF missing or format incorrect. |
| ORDER_REFUND_ORDER_AMOUNT_MISSING | ORDER_AMOUNT missing or format incorrect. |
| ERROR_CANCELLING_ORDER | Error canceling order. |
| ORDER_ALREADY_CANCELED | Order already canceled. |
| UNKNOWN_ERROR | Unknown error. |
| ORDER_REFUND_INVALID_ORDER_REF | Invalid ORDER_REF. |
| ORDER_REFUND_INVALID_ORDER_AMOUNT | Invalid ORDER_AMOUNT. |
| ORDER_REFUND_LINE_ITEM_REFERENCE_MISSING | ORDER_REFUND_LINE_ITEM_REFERENCE missing or format incorrect. |
| ORDER_REFUND_PRODUCTS_QTY_MISSING | PRODUCTS_QTY missing or format incorrect. |
| ORDER_REFUND_INVALID_PRODUCTS_QTY | Invalid PRODUCTS_QTY. |
| ORDER_REFUND_AMOUNT_MISSING | AMOUNT missing or format incorrect. |
| ORDER_REFUND_AMOUNT_INVALID | Invalid AMOUNT. |
| ORDER_REFUND_ALREADY_PLACED_TOTAL_REFUND | You have already placed a Total refund for this order. |
| ORDER_REFUND_ALREADY_PLACED | You have already placed a refund for this order. |
| ORDER_REFUND_ALREADY_HAVE_PENDING_REFUND_REQUEST | You already have a pending refund request. |
| ORDER_REFUND_AMOUNT_EXCEEDED_MAXIMUM_REFUNDABLE_AMOUNT | The maximum refundable amount for this order has been exceeded. |
| ORDER_REFUND_FAILED_DUE_TO_ORDER_CURRENT_STATUS | You cannot place a refund request due to the order's current status. |
| ORDER_REFUND_FAILED_DUE_TO_PAYMENT_DETAILS | You cannot place a refund request due to the order's payment details. |
| ORDER_REFUND_FAILED_DUE_TO_PERIOD_TO_REQUEST_REFUND_HAS_EXPIRED | The allowed period to request a new refund for this order has expired. |
| ORDER_REFUND_MULTIPLE_NOT_SUPPORTED_BY_PAYMENT_TYPE | Multiple refunds are not supported by this order's payment type. |
| ORDER_REFUND_NOT_SUPPORTED_FOR_CROSS_VENDOR_SALE | Refunding not supported for this Cross Vendor Sale order. |
| ORDER_REFUND_TOTAL_NEGATIVE | Order total is negative. |
| ORDER_REFUND_AMOUNT_NEGATIVE | Order amount is negative. |
| ORDER_REFUND_ITEM_AMOUNT_NEGATIVE | Order item amount is negative. |
| ORDER_REFUND_FAILED_DUE_TO_ORDER_APPROVAL_STATUS | You cannot place a refund request due to the order's approval status. |
| ORDER_REFUND_MULTIPLE_REFUNDS_NOT_SUPPORTED | Multiple refunds are not supported by this order's terminal. |
| ORDER_REFUND_PARTIAL_REVERSE_NOT_SUPPORTED | Partial reverse is not supported. |
| ORDER_REFUND_INVALID_PRODUCT_TYPE | Invalid product type. Refunds are available only for the following product types: REGULAR / BUNDLE / MEDIA / DOWNLOAD_INSURANCE / SHIPPING, but not for DISCOUNT. |
| ORDER_REFUND_FAILED_DUE_TO_OPEN_CHARGEBACK_DISPUTE | You cannot request a refund because a chargeback dispute was open for the order. |
| ORDER_REFUND_INVALID_REASON | Invalid REFUND_REASON. |
| ORDER_REFUND_LINE_ITEM_REFERENCES_NOT_FOUND | ORDER_REFUND_LINE_ITEM_REFERENCES is incorrect or not part of Order. |
| ORDER_REFUND_FEATURE_MISSING | You are not allowed to request refund. |
Item: Mark_Shipped
| Error code | Description |
|---|---|
| ORDER_MARK_SHIPPED_ALREADY_MARKED_SHIPPED | Sale already marked shipped. |
| ORDER_MARK_SHIPPED_NOT_SHIPPABLE | Item not shippable. |
| ORDER_MARK_SHIPPED_STATUS_INVALID | Order Status is not Payment Authorized. |
| ORDER_MARK_SHIPPED_AUTH_EXPIRED | Payment authorization has expired. Reauthorize payment before marking shipped. |
| ORDER_MARK_SHIPPED_TOO_SOON | Please wait 24 hours before trying to reauthorize again. |
| ORDER_MARK_SHIPPED_REAUTH_FAILED | Failed to reauthorize payment. |
| ORDER_MARK_SHIPPED_INTERNAL_ERROR_REAUTH | Failed to mark shipped but reauthorization succeeded. |
| ORDER_MARK_SHIPPED_INTERNAL_ERROR | Failed to mark shipped. |
Item: Shipping_Price
| Error code | Description |
|---|---|
| COUPON_CODES_INVALID | The coupon codes format is invalid. |
| BILLING_DETAILS_COUNTRY_INVALID | The billing country code is invalid. |
| DELIVERY_DETAILS_COUNTRY_INVALID | The delivery country code is invalid. |
| PARAMETERS_INVALID | The country code [%s] does not have a currency that is in your account's transactional currencies. |
| ITEMS_INVALID | The shipping price can only be calculated for physical products. |
Item: Billing_Details
| Error code | Description |
|---|---|
| ORDER_BILLING_DETAILS_COUNTRY_DYNAMIC_NOT_ALLOWED | Functionality not available for your account. |
| ORDER_BILLING_DETAILS_EMPTY | Billing details can not be used for delivery as they are empty. |
| ORDER_BILLING_EMAIL_EMPTY | Email cannot be empty. |
| ORDER_BILLING_EMAIL_EMAIL_INVALID | Email is not valid. |
| ORDER_BILLING_FIRST_NAME_EMPTY | The First Name cannot be empty. |
| ORDER_BILLING_LAST_NAME_EMPTY | The Last Name cannot be empty. |
| ORDER_BILLING_ADDRESS1_EMPTY | The Address 1 cannot be empty. |
| ORDER_BILLING_CITY_EMPTY | The City cannot be empty. |
| ORDER_BILLING_ZIP_EMPTY | The Zip cannot be empty. |
| ORDER_BILLING_STATE_EMPTY | The State cannot be empty. |
| ORDER_BILLING_DETAILS_COUNTRY_EMPTY | The Country cannot be empty. |
| ORDER_BILLING_DETAILS_COUNTRY_INVALID | The Country is not supported by the vendor. |
| ORDER_BILLING_DETAILS_STATE_EMPTY | The State cannot be empty. |
| ORDER_BILLING_DETAILS_STATE_INVALID | The State is not valid. |
| ORDER_BILLING_DETAILS_PHONE_EMPTY | The Phone cannot be empty. |
| ORDER_BILLING_DETAILS_CPF_CNPJ_EMPTY | The CPF/CPNJ cannot be empty. |
| ORDER_BILLING_DETAILS_CPF_CNPJ_INVALID | The CPF/CNPJ is invalid. |
| ORDER_BILLING_DETAILS_COMPANY_EMPTY | The Company cannot be empty. |
| ORDER_BILLING_DETAILS_GSTIN_EMPTY | The GSTIN number cannot be empty. |
| ORDER_BILLING_DETAILS_GSTIN_INVALID | The GSTIN number is invalid. |
| ORDER_BILLING_DETAILS_FISCAL_CODE_EMPTY | The Fiscal Code cannot be empty. |
| ORDER_BILLING_DETAILS_TAX_OFFICE_EMPTY | The Tax office cannot be empty. |
| ORDER_BILLING_DETAILS_TAX_OFFICE_INVALID | The Tax office is not valid. |
| ORDER_BILLING_DETAILS_FISCAL_CODE_INVALID | The Fiscal Code is not valid. |
| ORDER_BILLING_DETAILS_INVALID | No billing details have been provided. |
| ORDER_BILLING_DETAILS_EMAIL_EMPTY | The billing email cannot be empty. |
Item: Delivery
| Error code | Description |
|---|---|
| ORDER_DELIVERY_EMAIL_EMPTY | The Email cannot be empty. |
| ORDER_DELIVERY_EMAIL_EMAIL_INVALID | The Email is not valid. |
| ORDER_DELIVERY_FIRST_NAME_EMPTY | The First Name cannot be empty. |
| ORDER_DELIVERY_LAST_NAME_EMPTY | The Last Name cannot be empty. |
| ORDER_DELIVERY_ADDRESS1_EMPTY | The Address 1 cannot be empty. |
| ORDER_DELIVERY_CITY_EMPTY | The City cannot be empty. |
| ORDER_DELIVERY_ZIP_EMPTY | The Zip cannot be empty. |
| ORDER_DELIVERY_STATE_EMPTY | The State cannot be empty. |
| ORDER_DELIVERY_DETAILS_COUNTRY_INVALID | The country code is not valid for the current vendor. |
Item: Payment_Method
| Error code | Description |
|---|---|
|
ORDER_PAYMENT_METHOD_EMPTY |
No payment method has been provided. |
| ORDER_PAYMENT_METHOD_INVALID | The payment method is not supported by your account. |
| ORDER_PAYMENT_METHOD_PREVIOUS_ORDER_REFNO_EMPTY | The previous order reference number cannot be empty. |
| ORDER_PAYMENT_METHOD_RETRY_INVALID | This payment method is not supported for retrying this order. |
| ORDER_PAYMENT_METHOD_RESTRICTED | The payment method is restricted for product. |
| ORDER_PAYMENT_METHOD_COUNTRY_INVALID | The payment method is not available in the selected country. |
| ORDER_PAYMENT_METHOD_CURRENCY_INVALID | The payment currency is not supported for selected payment method. |
| ORDER_PAYMENT_METHOD_NOT_ALLOWED | Card processing is restricted. Your integration does not meet the requirements for handling sensitive card data. |
| ORDER_PAYMENT_METHOD_PREVIOUS_ORDER_EMAIL_INVALID | The billing email is different from the one of the reference order. |
| ORDER_PAYMENT_METHOD_CC_VENDOR_3DS_RETURN_URL_EMPTY | The PaymentDetails.PaymentMethod.Vendor3DSReturnURL can not be empty. |
| ORDER_PAYMENT_METHOD_CC_VENDOR_3DS_RETURN_URL_INVALID | The PaymentDetails.PaymentMethod.Vendor3DSReturnURL is not valid. |
| ORDER_PAYMENT_METHOD_CC_VENDOR_3DS_CANCEL_URL_EMPTY | The PaymentDetails.PaymentMethod.Vendor3DSCancelURL can not be empty. |
| ORDER_PAYMENT_METHOD_CC_VENDOR_3DS_CANCEL_URL_INVALID | The PaymentDetails.PaymentMethod.Vendor3DSCancelURL is not valid. |
| ORDER_PAYMENT_METHOD_PAYPAL_EXPRESS_PROCESS_ERROR | An error occurred while trying to place the order. |
| ORDER_PAYMENT_METHOD_PAYPAL_EXPRESS_INTERNAL_ERROR | An error from Paypal Express gateway. |
| ORDER_PAYMENT_METHOD_DIRECT_DEBIT_PROCESS_ERROR | An error occurred while trying to place the order. |
| ORDER_PAYMENT_METHOD_DIRECT_DEBIT_INTERNAL_ERROR | Generic error. |
| ORDER_PAYMENT_METHOD_IDEAL_PROCESS_ERROR | An error occurred while trying to place the order. |
| ORDER_PAYMENT_METHOD_IDEAL_INTERNAL_ERROR | Generic error. |
| ORDER_PAYMENT_METHOD_WE_CHAT_PAY_PROCESS_ERROR | An error occurred while trying to place the order. |
| ORDER_PAYMENT_METHOD_WE_CHAT_PAY_INTERNAL_ERROR | Generic error. |
| ORDER_PAYMENT_METHOD_DIRECT_DEBIT_SWIFT_EMPTY | The swift code cannot be empty. |
| ORDER_PAYMENT_METHOD_DIRECT_DEBIT_IBAN_EMPTY | The IBAN cannot be empty or exceed 28 characters./The FirstName cannot be empty or exceed 30 characters./The LastName cannot be empty or exceed 30 characters. |
| ORDER_PAYMENT_METHOD_IDEAL_BANK_CODE_EMPTY | The bank code cannot be empty. |
| ORDER_PAYMENT_METHOD_INVALID | The payment method [%s] is not supported. |
| ORDER_PAYMENT_METHOD_ORDER_REFERENCE_INVALID | Order reference number is required for [%s] payment method./Order reference number is invalid for subscription reference [%s]. |
Item: Payment_Details
| Error code | Description |
|---|---|
| ORDER_PAYMENT_DETAILS_INVALID | No payment details have been provided/Free orders without payment details are not enabled for your account. |
Other
| Error code | Description |
|---|---|
|
ORDER_PHYSICAL_FEATURE_MISSING |
You are not allowed to place orders with physical products. |
| ORDER_ERROR | Couldn't process the order/Order reference is invalid. |
| GIFT_ORDER_NOT_ALLOWED | Cannot place the order because order is marked as gift and product is not available as a gift. |
| TEST_ORDER_NOT_ALLOWED | Test orders are not available for your account. |
| ORDER_CURRENCY_MISMATCH | Order currency values must match. |
| ORDER_TOTAL_NEGATIVE | Order total must be zero or a positive value. |
| ORDER_TEST_MODE_REQUIRED | Test mode is required on test subscription. |