Para quem vende · API e webhooks

API: formato de erro, códigos e limites

Todo erro volta como statusCode, errorCode (GATEWAY_*), message e details. Há limite de vendas pendentes por método e janela (cada venda pendente com cobrança viva ocupa uma vaga; paga, cancelada, expirada ou recusada libera) e de consultas repetidas (TOO_MANY_REQUESTS); a análise de segurança da compra recusa com GATEWAY_TRANSACTION_DENIED.

Passo a passo

Trate pelo errorCode, não pelo texto da mensagem.
Em 400 de validação, leia details (campo e motivo).
Em TOO_MANY_REQUESTS, espere e use o webhook em vez de consultar em laço.
Em recusa da análise de segurança, não repita a mesma compra.

Já tem conta? Este passo a passo fica em Abrir API, no painel.

Isso ajudou?

Artigos relacionados

Instabilidade ou erro pontual: o que fazer antes de abrir um chamadoSe várias telas ou vendas falham ao mesmo tempo, confira a página de status (endereço /status do checkout). Se é só com você, junte os dados abaixo e fale com o suporte.
API: formato do endereço do compradorNo boleto e no cartão o endereço é obrigatório: country em ISO 3166-1 alfa-2 (BR), state como UF (aceitamos BR-SP), zipCode com ou sem hífen (volta com hífen) e complement opcional. Em GET /gateway/producer, o endereço de PJ é o da empresa.
Abrir chamado: o que vai junto e o prazo de respostaEm Fale com o suporte, escolha o tipo do chamado: o formulário mostra o que conferir antes e pede só o necessário. Para uma dúvida bastam o assunto e a mensagem; a mensagem de erro, o link do print e o ID do erro ficam em Tem uma mensagem de erro?, opcional. A tela de onde você veio, o seu e-mail, o seu perfil, o nome da operação e o último ID de erro vão sozinhos. O chamado em andamento fica no topo da página, com a resposta.
API: reportar bug, chave vazada e erro de IP no saqueEm Fale com o suporte, os tipos "Bug na API", "Minha chave da API vazou" e "IP não autorizado no saque" pedem os dados certos: endpoint, resposta com o requestId, passos e horário; no erro de IP, também o IP cadastrado e o IP de saída. Chaves e cartão colados são mascarados.