Listar Cancelamentos

GET/v1/refund/list?status={status}&id={id}&skip={skip}&take={take}

Utilizada para consultar a lista de pedidos de cancelamento, com opções de filtragem por status ou ID do cancelamento. Suporta paginação para melhor gerenciamento dos resultados.

Dicionário de dados - Query Parameters

Exemplo de requisição

curl --request GET \
  --url 'https://api.sopague.com.br/gateway/v1/refund/list?status=<string>&id=<guid>&skip=<int>&take=<int>' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json'

Exemplo de resposta

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "nsu": "123456789",
      "authorizationCode": "ABC123",
      "amount": 150.50,
      "operationDate": "2024-11-12",
      "installments": 1,
      "status": "PENDENTE",
      "description": "Solicitação do cliente"
    },
    {
      "id": "7fb95f64-8827-5673-c4gd-3d074g77bgb7",
      "nsu": "987654321",
      "authorizationCode": "XYZ789",
      "amount": 250.00,
      "operationDate": "2024-11-11",
      "installments": 3,
      "status": "CANCELADO",
      "description": "Produto não entregue"
    }
  ],
  "totalCount": 25,
  "skip": 0,
  "take": 10
}

Dicionário de dados - Retorno

Dica de Uso

Use o parâmetro status para filtrar pedidos em um estado específico
Use o parâmetro id quando precisar consultar um pedido específico
A paginação é útil para lidar com grandes volumes de dados
Se o parâmetro id for informado, os demais filtros são ignorados

Ordenação

Os resultados são sempre ordenados por data de criação em ordem decrescente (mais recentes primeiro).