Integrator

Erros

Os erros têm sempre o mesmo formato e um código estável para você tratar no seu sistema.

JSON
{
  "error": {
    "code": "insufficient_credits",
    "message": "O saldo de créditos atingiu o limite negativo. Recarregue para criar novas cobranças."
  }
}

Trate pelo code, não pela message: a mensagem é feita para gente ler e pode mudar. details é opcional.

HTTPcodeQuando acontece
400validation_errorCampos inválidos. details lista cada problema.
400invalid_idempotency_keyA Idempotency-Key está vazia ou passa de 255 caracteres.
400bad_requestRequisição malformada (JSON inválido, cursor inválido…).
401invalid_api_keyAPI key ausente, inválida ou revogada.
402insufficient_creditsSaldo no limite negativo. Recarregue para criar novas cobranças.
403account_blockedConta bloqueada. Fale com o suporte.
404charge_not_foundA cobrança não existe nesta conta.
404terminal_not_foundO terminal não existe nesta conta.
409terminal_revokedO terminal foi revogado.
409idempotency_conflictA Idempotency-Key já foi usada com outros dados.
409charge_not_cancelableA cobrança já saiu da fila e não pode ser cancelada pela API.
429rate_limitedMuitas requisições. Espere e tente de novo.
500internal_errorErro nosso. É seguro repetir com a mesma Idempotency-Key.

O que repetir

  • Pode repetir: erros de rede, timeouts, 429 e 5xx. Use a mesma Idempotency-Key.
  • Não adianta repetir: 4xx diferente de 429. Corrija a requisição ou a situação da conta antes.