GET /api/v1/refunds/ - Chargefy

Retorna todos os reembolsos processados pela organização.

Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`page`	`integer`	Não	Número da página (default: 1)
`limit`	`integer`	Não	Itens por página (default: 10, máx: 100)
`saleId`	`string`	Não	Filtrar por ID da venda
`sorting`	`string`	Não	Ordenação (ex: `-created_at`)

Campos da Resposta

Campo	Tipo	Descrição
`items`	`array`	Lista de reembolsos
`items[].id`	`string`	ID do reembolso
`items[].saleId`	`string`	ID da venda
`items[].amount`	`integer`	Valor reembolsado em centavos
`items[].currency`	`string`	Moeda
`items[].reason`	`string`	Motivo
`items[].status`	`string`	Status
`items[].createdAt`	`datetime`	Data de criação
`pagination`	`object`	Informações de paginação

Exemplo de Requisição

curl -X GET "https://api.chargefy.io/api/v1/refunds/?limit=20" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const refunds = await chargefy.refunds.list({ limit: 20 });

Exemplo de Resposta

{
  "items": [
    {
      "id": "ref_xyz789",
      "saleId": "sale_abc123",
      "amount": 5000,
      "currency": "brl",
      "reason": "Cliente solicitou cancelamento",
      "status": "succeeded",
      "createdAt": "2026-03-12T14:30:00Z"
    }
  ],
  "pagination": {
    "total_count": 12,
    "max_page": 1
  }
}