Refunds

POST /v1/charges/:id/refund

Cria um reembolso para uma cobrança.

Request body

Campo	Tipo	Obrigatório	Descrição
amount	Money		Valor do reembolso. Se omitido, reembolso total.
reason	string		Motivo do reembolso

Headers obrigatórios

Header	Descrição
Idempotency-Key	Chave única para evitar reembolsos duplicados

Exemplo

curl -X POST https://api.kirvex.com.br/v1/charges/ch_01J.../refund \
  -u sk_test_...: \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: refund-pedido-1234" \
  -d '{ "amount": { "amount": "5000", "currency": "BRL" }, "reason": "cliente desistiu" }'

Resposta (201)

{
  "id": "re_01J...",
  "object": "refund",
  "charge_id": "ch_01J...",
  "status": "pending",
  "amount": { "amount": "5000", "currency": "BRL" },
  "vendor": "pagarme",
  "vendor_ref": "or_...",
  "reason": "cliente desistiu",
  "created_at": "2026-04-29T12:01:00Z",
  "succeeded_at": null
}

---

GET /v1/refunds/:id

Retorna um reembolso pelo ID.

---

GET /v1/refunds

Lista reembolsos com paginação por cursor.

Query params

Campo	Tipo	Descrição
cursor	string	Cursor da página anterior
limit	number	Máximo de resultados (1–100, default 20)
charge_id	string	Filtrar por cobrança