Referência

Erros

A API usa códigos HTTP convencionais e devolve um corpo JSON com um code estável e uma message legível. Trate sempre pelo code, não pelo texto.

Códigos HTTP

200 / 201sucessoopcional
A requisição foi processada com sucesso.
400bad requestopcional
Requisição malformada ou faltando header obrigatório.
401unauthorizedopcional
Chave de API ausente ou inválida.
403forbiddenopcional
A chave não tem o escopo necessário.
404not foundopcional
O recurso não existe (ou não é do seu Merchant).
422unprocessableopcional
A requisição é válida mas não pode ser cumprida (ex.: método não suportado).
429rate limitedopcional
Excesso de requisições. Veja rate limiting.

Códigos de erro

API_KEY_UNAUTHORIZED401opcional
Chave ausente, inválida, expirada ou revogada.
INSUFFICIENT_SCOPE403opcional
A chave não possui o escopo exigido (ex.: charge:write).
IDEMPOTENCY_KEY_REQUIRED400opcional
Falta o header Idempotency-Key (mín. 8 chars) na criação.
METHOD_NOT_SUPPORTED422opcional
Método de pagamento ainda não suportado. Use pix.
NO_ACTIVE_PIX_KEY422opcional
O Merchant não possui chave PIX ativa para gerar o QR.
PIX_KEY_NOT_FOUND422opcional
A pix_key informada não existe ou não está ativa.
CHARGE_NOT_FOUND404opcional
Cobrança inexistente para o seu Merchant.
AMOUNT_REQUIRED422opcional
Falta amount no pagamento (obrigatório, exceto PIX pix_code).
PAYOUT_DESTINATION_REQUIRED422opcional
PIX sem destino: informe pix_key, pix_code ou recipient.
PAYOUT_END_TO_END_ID_REQUIRED422opcional
Payout por pix_key sem end_to_end_id. Consulte a chave em POST /v1/pix/dict/lookup e reenvie o id devolvido.
PIX_DICT_LOOKUP_EXPIRED422opcional
O end_to_end_id enviado já foi usado, expirou (12h) ou não é seu. Consulte a chave de novo.
PIX_DICT_LOOKUP_IN_USE409opcional
Já existe um payout em andamento com esse end_to_end_id. Aguarde o resultado antes de repetir.
PIX_DICT_QUOTA_EXCEEDED429opcional
Cota de consultas de chave PIX excedida. Consulte uma vez por pagamento; veja rate limiting.
PIX_DICT_LOOKUP_KEY_MISMATCH422opcional
O end_to_end_id pertence à consulta de outra chave. Use o id devolvido para a chave que está pagando.
PIX_DICT_RATE_LIMITED429opcional
O limite de consultas de chave PIX do Banco Central foi atingido nesta conta. As consultas ficam suspensas por alguns minutos. Não repita a chamada: cada tentativa durante o bloqueio aprofunda o limite.
TED_RECIPIENT_REQUIRED422opcional
TED exige o objeto recipient com a conta bancária.
PAYOUT_INVALID422opcional
Dados do pagamento inválidos (ex.: finalidade Outros sem descrição).
PAYOUT_NOT_FOUND404opcional
Pagamento inexistente para o seu Merchant.
Formato do erro
{
  "code": "METHOD_NOT_SUPPORTED",
  "message": "Método \"boleto\" ainda não é suportado. Use \"pix\"."
}