AI resources

Possible errors

During integration with Checkout Pro through the Orders API, errors may occur in requests to the different endpoints. Below are the error codes organized by endpoint, along with their cause and solution.

Errors creating an order

HTTP CodeError codeMessageCause and solution
400empty_required_headerMissing HTTP header: X-Idempotency-KeyInclude the X-Idempotency-Key header with a unique UUID in the request.
400invalid_idempotency_key_lengthX-Idempotency-Key length exceeds 128 charactersReduce the idempotency key length to a maximum of 128 characters.
400required_propertiesrequired property 'email' is missingVerify that all required fields are present in the request body.
400invalid_total_amounttotal_amount is not equivalent to sum...Verify that the total_amount value equals the sum of the unit_price multiplied by the quantity of all items in the order.
400maximum_itemsmaximum 1 items required, but found 2Send only 1 transaction per order in the request.
400unsupported_propertiesAn unsupported property was sent. Check the message returned in the error details.An unsupported field was included in the request body. Check the details field in the error response to identify which property caused the issue, remove it, and retry.
400minimum_propertiesThe minimum number of properties required was not sent. Check the error detailsThe request did not include the minimum number of required properties. Check the details field in the error response to identify which object or sub-object is missing mandatory fields, and retry with the complete payload.
400idempotency_validation_failedValidation fail. Please try submitting the request againThe server failed to validate the idempotency key on its end. This is a transient server-side error. Generate a new X-Idempotency-Key and resubmit the request.
400property_valueinvalid value 'X', expected one of: online, point, qrUse the value online in the type field for Checkout Pro integrations.
400property_typeexpected string, but got numberCheck the data types for each field. See the API reference for more details.
400json_syntax_errorAn incorrect JSON was sentValidate the JSON syntax in the request body.
400invalid_email_for_sandboxEmail must contain '@testuser.com'Use email addresses with the @testuser.com domain in the sandbox environment.
409idempotency_key_already_usedX-Idempotency-Key already used...Generate a new idempotency key. The key sent was already used in a previous request.
423resource_lockedIdempotency Key Locked...The resource is being processed with the same idempotency key. Wait a few seconds and try again.
500internal_errorSome error occurred on our sideInternal server error. Retry the request later.

Errors checking an order

HTTP CodeError codeMessageCause and solution
400invalid_path_paramPath param order id is invalidVerify that the order ID has the correct format (ULID).
404order_not_foundorder not foundVerify that the Access Token corresponds to the order creator.

Errors canceling an order

HTTP CodeError codeMessageCause and solution
400invalid_path_paramPath param order id is invalidVerify that the order ID has the correct format (ULID).
400empty_required_headerMissing HTTP header: X-Idempotency-KeyInclude the X-Idempotency-Key header with a unique UUID.
404order_not_foundorder not foundVerify that the Access Token corresponds to the order creator.
409cannot_cancel_orderOnly orders with status 'action_required' or 'created'...The order is in an incompatible state for cancellation. Only orders with status created or action_required can be canceled.
409order_already_cancelledThe order has already been canceledThe order has already been canceled. There is no need to send the request again.

Errors refunding an order

HTTP CodeError codeMessageCause and solution
400refund_amount_exceedsRefund amount exceeds the available amountThe refund amount exceeds the available amount. Check the available amount for refund.
400order_refund_already_in_processThere is already a full refund request in processThere is already a full refund request in process. Wait for it to complete before submitting a new request.
404transaction_not_foundTransaction not foundVerify that the transaction ID is correct.
409cannot_refund_orderCannot refund order...The order must be in processed status for a refund to be requested.

For more information on how to submit requests, requirements, and necessary validations, see our API referenceAPI.