Reembolsos
Você pode reembolsar cobranças pagas total ou parcialmente através da API.
Endpoint
POST /v1/charges/{id}/refund
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount |
integer | Não | Valor do reembolso em centavos (se omitido, reembolsa o valor total) |
Exemplo de Requisição
curl -X POST https://api.apexpy.com.br/v1/charges/ci_123/refund \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"amount": 5000
}'
Exemplo de Resposta
{
"success": true,
"data": {
"id": "ci_123",
"status": "refunded",
"refunded_amount": 5000,
"refunded_at": "2025-11-28T20:30:00Z"
}
}
Regras de Reembolso
- Apenas cobranças com status
paidoupendingpodem ser reembolsadas - O valor do reembolso não pode exceder o valor da cobrança
- Reembolsos parciais são permitidos (envie o parâmetro
amountem centavos) - Se
amountnão for informado, o reembolso será total - O status da cobrança muda para
refundedapós o reembolso