Criar Cobrança
POST /v1/charges (ou /v1/payments) • escopo payments:write
Parâmetros da Requisição (Body JSON)
Resposta de Sucesso (HTTP 201 Created)
Consultar Cobrança
GET /v1/charges/{id} • escopo payments:read
Busca os dados detalhados da cobrança. O parâmetro {id} pode ser o ID da KavroPay (PAY...) ou o seu externalId.
Listar Cobranças (Paginado)
GET /v1/charges • escopo payments:read • Listagem otimizada < 15ms
Query Params: status (paid/waiting_payment/expired), limit (1 a 100), offset (0, 20…)
Cancelar Cobrança
POST /v1/charges/{id}/cancel • escopo payments:write
Cancela uma cobrança que ainda está com status waiting_payment. Cobranças já paid não podem ser canceladas — use Saques PIX para devolver o valor manualmente, se necessário.
Cobranças
expired não podem ser canceladas manualmente — elas já saem de circulação automaticamente quando o prazo vence.