Listar reembolsos

Lista os pedidos de reembolso das suas vendas, do mais recente para o mais antigo — abertos pelo comprador ou por você. Cada pedido traz a situação, o motivo, o valor (quando parcial) e a venda a que pertence.

Para ser avisado em tempo real, assine os webhooks TRANSACTION_ASK_REFUNDING (pedido recebido) e TRANSACTION_REFUNDED (estorno concluído).

Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.

GET
/refunds
AuthorizationBearer <token>

Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.

In: header

Query Parameters

page?integer

Número da página, começando em 1.

Default1
Range1 <= value
per_page?integer

Itens por página, de 1 a 100.

Default25
Range1 <= value <= 100
status?string

Situação do pedido (veja Refund.status).

sale_identifier?string

Código da venda — traz só os pedidos dessa venda.

created_from?string

Solicitações de reembolso criadas a partir desta data e hora, incluindo ela. ISO 8601 com fuso.

Formatdate-time
created_to?string

Solicitações de reembolso criadas até esta data e hora, incluindo ela. ISO 8601 com fuso.

Formatdate-time
customer_email?string

E-mail do cliente da venda. E-mail completo, sem diferenciar maiúsculas de minúsculas.

Formatemail
customer_document?string

Documento do cliente da venda. CPF com 11 dígitos ou CNPJ com 14, com ou sem pontuação.

Response Body

curl -X GET "https://pagpolar-api.creativecode.dev.br/v1/refunds?page=1&per_page=25&status=string&sale_identifier=string&created_from=2019-08-24T14%3A15%3A22Z&created_to=2019-08-24T14%3A15%3A22Z&customer_email=user%40example.com&customer_document=123.456.789-09"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "REFUNDED",
      "requested_by": "CLIENT",
      "is_partial": false,
      "refund_amount": null,
      "reason": "Não atendeu às expectativas",
      "customer_observation": null,
      "refused_reason": null,
      "canceled_reason": null,
      "return_tracking": {
        "code": "BR123456789BR",
        "provider": "string",
        "sent_at": "2019-08-24T14:15:22Z",
        "received_at": "2019-08-24T14:15:22Z"
      },
      "sale": {
        "identifier": "PPO9876543210",
        "status": "REFUNDED",
        "payment_method": "PIX",
        "total_amount": 197
      },
      "customer": {
        "id": "e6f7a8b9-c0d1-4e2f-3a4b-5c6d7e8f9a0b",
        "name": "Maria Souza",
        "email": "maria@exemplo.com",
        "document": "***.456.***-**",
        "phone": "****4321",
        "is_active": true,
        "created_at": "2026-01-05T08:00:00.000Z"
      },
      "created_at": "2026-01-25T09:00:00.000Z",
      "updated_at": "2026-01-27T16:20:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 143,
    "total_pages": 6
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "request_id": "string"
  }
}