Pular para o conteúdo principal

Erros

Erros usam o envelope padrão com error.code estável.

HTTPCódigoQuando aconteceO que fazer
400BAD_REQUESTRequisição inválida (ex.: falta Idempotency-Key).Corrija a requisição.
400INVALID_JSONCorpo não é JSON válido.Envie JSON válido.
401MISSING_API_KEYNenhuma chave enviada.Envie Authorization: Bearer ….
401INVALID_API_KEYChave desconhecida.Confira a chave.
401API_KEY_REVOKEDChave revogada.Gere outra no painel.
401API_KEY_EXPIREDChave expirada.Gere outra no painel.
401API_KEY_INACTIVEChave inativa.Reative ou gere outra.
403INSUFFICIENT_PERMISSIONSA chave não tem a permissão do endpoint.Ajuste as permissões.
403MERCHANT_INACTIVELojista vinculado não está ativo.Fale com o suporte.
403MERCHANT_SUSPENDEDLojista suspenso.Fale com o suporte.
403MERCHANT_BLOCKEDLojista bloqueado.Fale com o suporte.
403FORBIDDENAcesso negado ao recurso.—
404NOT_FOUNDRecurso não existe (ou não pertence ao seu lojista).Confira o id.
404ROUTE_NOT_FOUNDEndpoint inexistente.Confira a URL.
405METHOD_NOT_ALLOWEDMétodo HTTP não suportado no endpoint.Use o método correto.
409CONFLICTIdempotency-Key reutilizada com outro corpo, ou em uso.Use outra chave / aguarde e repita.
422VALIDATION_ERRORCampos inválidos. Veja error.details.fields.Corrija os campos apontados.
422RISK_LIMIT_EXCEEDEDLimite de risco do lojista excedido.Fale com o suporte.
429RATE_LIMITEDMuitas requisições.Aguarde Retry-After.
500INTERNAL_ERRORErro interno.Tente de novo; informe o x-request-id.
503RATE_LIMIT_UNAVAILABLEProteção de abuso indisponível por instantes.Tente de novo em instantes.

Boas práticas​

  • Repita apenas erros transitórios: 409 (em processamento), 429, 500 e 503 — sempre com a mesma Idempotency-Key nas operações de criação.
  • Não repita 4xx sem corrigir a causa.
  • Ao abrir um chamado, informe o header x-request-id da resposta.