Recursos para IA

Possíveis erros

Durante a integração de Checkout Pro através da API de Orders, as requisições aos endpoints podem retornar erros. A tabela a seguir apresenta os códigos de erro agrupados por endpoint, bem como suas respectivas descrições, causas e ações recomendadas para correção.

Erros ao criar uma order

Código HTTPCódigo de erroMensagemCausa e solução
400empty_required_headerMissing HTTP header: X-Idempotency-KeyInclua o header X-Idempotency-Key com um UUID único na solicitação.
400invalid_idempotency_key_lengthX-Idempotency-Key length exceeds 128 charactersReduza o comprimento da chave de idempotência para no máximo 128 caracteres.
400required_propertiesrequired property 'email' is missingVerifique se todos os campos obrigatórios estão presentes no corpo da solicitação.
400invalid_total_amounttotal_amount is not equivalent to sum...Verifique se o valor de total_amount é igual à soma do unit_price multiplicado pela quantity de todos os itens da order.
400maximum_itemsmaximum 1 items required, but found 2Envie apenas uma transação por order na solicitação.
400unsupported_propertiesAn unsupported property was sent. Check the message returned in the error details.Um campo não suportado foi incluído no corpo da solicitação. Verifique o campo details na resposta de erro para identificar qual propriedade causou o problema, remova-a e tente novamente.
400minimum_propertiesThe minimum number of properties required was not sent. Check the error detailsA solicitação não incluiu o número mínimo de propriedades obrigatórias. Verifique o campo details na resposta de erro para identificar qual objeto ou sub-objeto está com campos obrigatórios faltando e tente novamente com o payload completo.
400idempotency_validation_failedValidation fail. Please try submitting the request againO servidor não conseguiu validar a chave de idempotência. Este é um erro transitório do lado do servidor. Gere um novo X-Idempotency-Key e reenvie a solicitação.
400property_valueinvalid value 'X', expected one of: online, point, qrUtilize o valor online no campo type para integrações de Checkout Pro.
400property_typeexpected string, but got numberVerifique os tipos de dados de cada campo. Consulte a referência da API para mais detalhes.
400json_syntax_errorAn incorrect JSON was sentValide a sintaxe do JSON enviado no corpo da solicitação.
400invalid_email_for_sandboxEmail must contain '@testuser.com'Utilize e-mails com domínio @testuser.com no ambiente de testes (sandbox).
409idempotency_key_already_usedX-Idempotency-Key already used...Gere uma nova chave de idempotência. A chave enviada já foi utilizada em uma solicitação anterior.
423resource_lockedIdempotency Key Locked...O recurso está sendo processado com a mesma chave de idempotência. Aguarde alguns segundos e tente novamente.
500internal_errorSome error occurred on our sideErro interno do servidor. Tente novamente mais tarde.

Erros ao consultar uma order

Código HTTPCódigo de erroMensagemCausa e solução
400invalid_path_paramPath param order id is invalidVerifique se o ID da order está no formato correto (ULID).
404order_not_foundorder not foundVerifique se o Access Token corresponde ao criador da order.

Erros ao cancelar uma order

Código HTTPCódigo de erroMensagemCausa e solução
400invalid_path_paramPath param order id is invalidVerifique se o ID da order está no formato correto (ULID).
400empty_required_headerMissing HTTP header: X-Idempotency-KeyInclua o header X-Idempotency-Key com um UUID único.
404order_not_foundorder not foundVerifique se o Access Token corresponde ao criador da order.
409cannot_cancel_orderOnly orders with status 'action_required' or 'created'...A order está em um status incompatível para cancelamento. Apenas orders com status created ou action_required podem ser canceladas.
409order_already_cancelledThe order has already been canceledA order já foi cancelada anteriormente. Não é necessário enviar a solicitação novamente.

Erros ao reembolsar uma order

Código HTTPCódigo de erroMensagemCausa e solução
400refund_amount_exceedsRefund amount exceeds the available amountO valor do reembolso excede o valor disponível. Verifique o valor disponível para reembolso.
400order_refund_already_in_processThere is already a full refund request in processJá existe uma solicitação de reembolso total em processamento. Aguarde a conclusão antes de enviar uma nova solicitação.
404transaction_not_foundTransaction not foundVerifique se o ID da transação está correto.
409cannot_refund_orderCannot refund order...A order deve estar com status processed para que um reembolso possa ser solicitado.

Para obter mais informações sobre como enviar as solicitações, requisitos e validações necessárias, consulte nossa Referência de APIAPI.