POST /api/v1/sales/:id/refund

Solicita o estorno total ou parcial de uma venda aprovada.

Solicita o estorno de uma venda. Por padrão, o estorno é realizado pelo valor total da venda. É possível informar um valor parcial em centavos e um motivo para o estorno.

​

Autenticação

Requer Organization Access Token via header Authorization: Bearer.

Escopos aceitos: web:write ou sales:write.

​

Parâmetros de Path

id · string · required

Identificador único da venda a ser estornada.

​

Corpo da Requisição

amount · integer

Valor do estorno em centavos. Se não informado, o estorno será realizado pelo valor total da venda.

reason · string

Motivo do estorno. Campo livre, usado para registro interno.

​

Resposta

id · string

Identificador único do estorno.

amount · integer

Valor estornado em centavos.

reason · string

Motivo registrado para o estorno.

status · string

Status do estorno. Valores possíveis: pending, succeeded, failed.

created_at · string

Data e hora de criação do estorno no formato ISO 8601.

​

Exemplo

cURL

curl -X POST "https://api.chargefy.io/api/v1/sales/sale_01j9abc123/refund" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 4950,
    "reason": "Solicitação do cliente"
  }'

​

Resposta de Exemplo

{
  "id": "refund_01j9def456",
  "amount": 4950,
  "reason": "Solicitação do cliente",
  "status": "succeeded",
  "created_at": "2024-11-05T15:30:00Z"
}