Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

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âmetroTipoObrigatórioDescrição
pageintegerNãoNúmero da página (default: 1)
limitintegerNãoItens por página (default: 10, máx: 100)
saleIdstringNãoFiltrar por ID da venda
sortingstringNãoOrdenação (ex: -created_at)

​
Campos da Resposta

CampoTipoDescrição
itemsarrayLista de reembolsos
items[].idstringID do reembolso
items[].saleIdstringID da venda
items[].amountintegerValor reembolsado em centavos
items[].currencystringMoeda
items[].reasonstringMotivo
items[].statusstringStatus
items[].createdAtdatetimeData de criação
paginationobjectInformaçõ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"

​
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
  }
}