Listar Cancelamentos

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Consultar lista de cancelamentos

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.

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

Dicionário de dados - Query Parameters

PARÂMETRO	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
status	Filtrar por status do pedido	string	50	Opcional. Valores: PENDENTE, CANCELADO, APROVADO, REJEITADO
id	Filtrar por ID específico do pedido	guid	-	Opcional.
skip	Número de registros a pular	int	-	Opcional. Padrão: 0
take	Número de registros a retornar	int	-	Opcional. Padrão: 10. Máximo: 100

🟢 200 - OK

{
  "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
}

🟢 200 - Sem Resultados

{
  "items": [],
  "totalCount": 0,
  "skip": 0,
  "take": 10
}

Dicionário de dados - Response

CAMPO	DESCRIÇÃO	TIPO	OBSERVAÇÃO
items	Lista de pedidos de cancelamento	array	-
items[].id	Identificador único do pedido	guid	-
items[].nsu	Número de identificação da operação	string	-
items[].authorizationCode	Código de autorização da operação	string	-
items[].amount	Valor total da transação	decimal	-
items[].operationDate	Data da operação	date	Formato: YYYY-MM-DD
items[].installments	Número total de parcelas	int	-
items[].status	Status do pedido	string	PENDENTE, CANCELADO, APROVADO, REJEITADO
items[].description	Motivo da solicitação	string	-
totalCount	Total de registros encontrados	int	Considera filtros aplicados
skip	Número de registros pulados	int	Valor da paginação
take	Número de registros retornados	int	Valor da paginação

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).