Formato padrão
code é o melhor ponto de partida para tratar erros de forma programática. Já o campo error_messages traz detalhes que ajudam a entender qual campo ou regra precisa de atenção.
Códigos HTTP
| Status | Code comum | Causa |
|---|---|---|
400 | ZodValidationException ou código de domínio | Payload, query string ou regra de negócio inválida. |
401 | unauthorized | apiKey ou token ausente ou inválido. |
403 | forbidden | Credencial sem acesso à empresa ou permissão solicitada. |
404 | company_not_found, transaction_not_found | Recurso não encontrado. |
500 | unknown_server_error | Erro não mapeado no servidor. |
Erros de negócio comuns
| Code | Quando pode ocorrer |
|---|---|
company_disabled | Empresa ou seller inativo. |
payment_method_already_exists | Cartão já vinculado a outro cliente. |
attempt_limit_exceeded | Limite de cartões por cliente excedido em produção. |
integration_access_not_found | Integração de pagamento ausente para a empresa. |
transaction_not_found | Transação não encontrada para captura, cancelamento ou consulta. |
product_not_found | Produto inexistente ou inacessível. |
client_not_found | Cliente inexistente ou inacessível. |
charge_not_found | Cobrança inexistente ou inacessível. |
Como investigar
Confira a autenticação
Se o status for
401, confirme se o header apiKey ou token foi enviado e se pertence ao mesmo ambiente da URL usada.Confira o acesso à empresa
Se o status for
403, revise o companyId e as permissões da credencial. A API valida o acesso por empresa e por recurso.Revise o payload
Se o status for
400, leia error_messages. Falhas de validação usam Zod e podem indicar o campo, o path e a localização do problema.