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 / 201sucessoopcionalA requisição foi processada com sucesso.
400bad requestopcionalRequisição malformada ou faltando header obrigatório.
401unauthorizedopcionalChave de API ausente ou inválida.
403forbiddenopcionalA chave não tem o escopo necessário.
404not foundopcionalO recurso não existe (ou não é do seu Merchant).
422unprocessableopcionalA requisição é válida mas não pode ser cumprida (ex.: método não suportado).
429rate limitedopcionalExcesso de requisições. Veja rate limiting.
Códigos de erro
API_KEY_UNAUTHORIZED401opcionalChave ausente, inválida, expirada ou revogada.
INSUFFICIENT_SCOPE403opcionalA chave não possui o escopo exigido (ex.:
charge:write).IDEMPOTENCY_KEY_REQUIRED400opcionalFalta o header
Idempotency-Key (mín. 8 chars) na criação.METHOD_NOT_SUPPORTED422opcionalMétodo de pagamento ainda não suportado. Use
pix.NO_ACTIVE_PIX_KEY422opcionalO Merchant não possui chave PIX ativa para gerar o QR.
PIX_KEY_NOT_FOUND422opcionalA
pix_key informada não existe ou não está ativa.CHARGE_NOT_FOUND404opcionalCobrança inexistente para o seu Merchant.
AMOUNT_REQUIRED422opcionalFalta
amount no pagamento (obrigatório, exceto PIX pix_code).PAYOUT_DESTINATION_REQUIRED422opcionalPIX sem destino: informe
pix_key, pix_code ou recipient.PAYOUT_END_TO_END_ID_REQUIRED422opcionalPayout 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_EXPIRED422opcionalO
end_to_end_id enviado já foi usado, expirou (12h) ou não é seu. Consulte a chave de novo.PIX_DICT_LOOKUP_IN_USE409opcionalJá existe um payout em andamento com esse
end_to_end_id. Aguarde o resultado antes de repetir.PIX_DICT_QUOTA_EXCEEDED429opcionalCota de consultas de chave PIX excedida. Consulte uma vez por pagamento; veja rate limiting.
PIX_DICT_LOOKUP_KEY_MISMATCH422opcionalO
end_to_end_id pertence à consulta de outra chave. Use o id devolvido para a chave que está pagando.PIX_DICT_RATE_LIMITED429opcionalO 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_REQUIRED422opcionalTED exige o objeto
recipient com a conta bancária.PAYOUT_INVALID422opcionalDados do pagamento inválidos (ex.: finalidade Outros sem descrição).
PAYOUT_NOT_FOUND404opcionalPagamento inexistente para o seu Merchant.
Formato do erro
{
"code": "METHOD_NOT_SUPPORTED",
"message": "Método \"boleto\" ainda não é suportado. Use \"pix\"."
}