Base URL
Todas as requisições da v2 usam o seguinte endereço:Autenticação
Toda requisição deve incluir sua chave de API no headerAuthorization:
401 Unauthorized. Consulte a página de autenticação para criar e gerenciar suas chaves.
Formato de resposta
Todos os endpoints retornam JSON com a mesma estrutura:Sempre verifique
success antes de acessar data. Nunca assuma que a requisição funcionou apenas pelo status HTTP.Códigos de status HTTP
Permissões
Cada chave de API pode ter permissões granulares por recurso. Se você receber403, verifique se a chave usada tem a permissão necessária para o endpoint. Consulte a página de autenticação para ver todas as permissões disponíveis.
Paginação
Endpoints de listagem retornam todos os registros disponíveis. Futuramente suportarão paginação vialimit e offset.
Dicas gerais
Use Dev mode para testes
Chaves de desenvolvimento simulam pagamentos sem cobranças reais.
Armazene a chave em variável de ambiente
Nunca comite sua chave de API no código. Use
process.env, .env ou um gerenciador de segredos.Idempotência em webhooks
Sempre registre o ID do evento recebido e descarte duplicatas.
Backoff em erros 5xx
Implemente retentativas com espera crescente para falhas temporárias.