Skip to main content
A API segue convenções HTTP padrão. Em caso de erro, você recebe um objeto JSON com os campos statusCode, message e error.

Códigos comuns

Formato do erro

O campo message pode vir como string única ou array de mensagens (no caso de validações do class-validator).

Boas práticas

  • Sempre logue o statusCode e message retornados para debug.
  • Em 429, aplique backoff exponencial antes de tentar novamente.
  • Em 5xx, reenvie a mesma x-idempotency-key para evitar duplicação quando o servidor voltar.
  • Em 409 de subcontas, não retry - revise o payload, gere uma nova chave se for uma operação nova.
  • Em 409 PAYMENT_IN_PROGRESS de pagamentos, a primeira requisição ainda está em processamento: aguarde alguns segundos e reenvie com a mesma chave. O retry pode devolver a transação ou outro 409 enquanto o processamento não terminar. Não há nova cobrança.
  • Em 422 IDEMPOTENCY_PAYLOAD_MISMATCH, a mesma chave foi reutilizada com um corpo diferente: se for uma operação nova, gere uma chave nova. Detalhes em Autenticação → Idempotência.
  • Em 404/409/410 de upsellToken, não retry com o mesmo token: ele é de uso único e não é reemitido. Para cobrar o upsell, colete o cartão novamente ou use um cardTokenId do Cofre.