API da Velon
Proposta de API para cobranças, vendas, reembolsos e eventos. Os exemplos abaixo são ilustrativos: não há sandbox executável nem endpoints de produção confirmados. Autenticação, assinaturas, limites e reenvios descrevem o comportamento planejado.
Autenticação
Envie sua chave secreta no cabeçalho Authorization. Nunca exponha a chave no navegador.
POST/charges
Cria uma cobrança Pix, cartão ou boleto.
Resposta:
GET/charges/:id
Consulta o status: pending, paid, failed, refunded.
POST/charges/:id/refund
Reembolsa a venda pelo mesmo meio de pagamento, dentro do prazo de 7 dias.
Webhooks
Enviamos um POST para a sua URL a cada evento. Valide o cabeçalho Velon-Signature (HMAC SHA-256 do corpo com o segredo do webhook) e responda 2xx em até 10 segundos. Falhas são reenviadas por até 24 horas.
Eventos
| Evento | Quando acontece |
|---|---|
| charge.created | Cobrança criada |
| charge.paid | Pagamento aprovado |
| charge.failed | Pagamento recusado ou expirado |
| charge.refunded | Reembolso concluído |
| payout.paid | Saque enviado por Pix |
Limites e erros
100 requisições por minuto por chave. Erros usam HTTP 4xx com { "error": { "code", "message" } }. Use o cabeçalho Idempotency-Key para repetir chamadas com segurança.