Listar Informes

Utilice este endpoint para listar informes con filtros.

Entornos Disponibles

Producción

https://api.gateway.com.br/core

Endpoint

• Método: GET
• Endpoint: /report
• Autenticación: Bearer token

Query Params

ℹ️ Fechas en ISO

Los campos startDate y endDate deben enviarse como ISO date string con hora.

Ejemplo:

• 2026-03-06T12:00:00.000Z

ℹ️ Paginación por snapshot

El snapshot no es un puntero a la "página siguiente": es un identificador fijo de la sesión de paginación, usado junto con page (que se sigue enviando e incrementando normalmente) para mantener los resultados consistentes incluso si se crean nuevos registros durante la navegación.

Tome el valor de snapshot de la primera respuesta (enviada sin snapshot en la primera solicitud) y reenvíe ese mismo valor, sin alterarlo, en las solicitudes de las páginas siguientes, junto con los mismos filtros y el mismo perPage usados originalmente. Si alguno de esos valores cambia mientras se reenvía un snapshot anterior, la API devuelve un error.

Nombre	Tipo	Obligatorio	Descripción	Validaciones
snapshot	string	No	Identificador de la sesión de paginación (recibido en el campo snapshot de la primera respuesta); reenvíelo sin alterar junto con page en las páginas siguientes	Debe corresponder a los mismos filtros y al mismo perPage de la solicitud original
startDate	string	No	Fecha inicial del filtro	Debe ser una ISO date string con hora
endDate	string	No	Fecha final del filtro	Debe ser una ISO date string con hora
status	string[] (enum) - PENDING, PROCESSING, FAILED, PROCESSED	No	Lista de estados	Debe ser un arreglo no vacío y sin duplicados
type	string[] (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES	No	Lista de tipos de informe	Debe ser un arreglo no vacío y sin duplicados
origin	string[] (enum) - ADMIN, USER	No	Origen del informe	Debe ser un arreglo no vacío y sin duplicados
id	string (UUID v4)	No	Identificador del informe	Debe ser un UUID v4 válido
userName	string	No	Nombre del usuario	Máximo 255 caracteres
userEmail	string	No	Correo electrónico del usuario	Debe ser un correo válido

Ejemplo de Solicitud

cURL

curl --request GET \
--url "https://api.gateway.com.br/core/report?status=PROCESSED&type=TRANSACTION&origin=USER" \
--header 'Authorization: Bearer su-token-jwt'

JavaScript

const params = new URLSearchParams({
  status: 'PROCESSED',
  type: 'TRANSACTION',
  origin: 'USER'
});

const response = await fetch(`https://api.gateway.com.br/core/report?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer su-token-jwt'
  }
});
const data = await response.json();

Respuesta Exitosa

Campo	Tipo	Obligatorio	Descripción
totalPages	number	Sí	Total de páginas
currentPage	number	Sí	Página actual
perPage	number	Sí	Elementos por página
snapshot	string	No	Identificador de la sesión de paginación; reenvíelo sin alteraciones en las páginas siguientes
data	array	Sí	Lista de informes (ver Sub-Objeto ListItem)

Sub-Objetos

ListItem

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Identificador del informe
status	string (enum)	Sí	Estado del informe (PENDING, PROCESSING, FAILED, PROCESSED)
type	string (enum)	Sí	Tipo del informe (TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES)
user	object	Sí	Datos del usuario (ver Sub-Objeto User)
origin	string (enum)	No	Origen del informe (ADMIN, USER)
filters	object	Sí	Filtros usados en el informe (ver Sub-Objeto Filters)
file	object	No	Archivo del informe (ver Sub-Objeto File)
expirationDate	string (ISO)	No	Fecha de expiración del archivo
errorMessage	string	No	Mensaje de error
createdAt	string (ISO)	Sí	Fecha de creación
updatedAt	string (ISO)	Sí	Fecha de la última actualización

User

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Identificador del usuario
name	string	Sí	Nombre del usuario
email	string	Sí	Correo electrónico del usuario

Filters

Campo	Tipo	Obligatorio	Descripción
startDate	string	Sí	Fecha inicial del filtro
endDate	string	Sí	Fecha final del filtro
storeId	string (UUID v4)	No	Identificador de la tienda
userId	string (UUID v4)	No	Identificador del usuario
status	string[]	No	Lista de estados aplicados
paymentMethod	string[]	No	Métodos de pago
acquirer	string[]	No	Adquirentes del informe

File

Campo	Tipo	Obligatorio	Descripción
key	string	Sí	Clave del archivo
isPrivate	boolean	Sí	Indica si el archivo es privado
url	string	Sí	URL para acceder al archivo

Ejemplo de Respuesta

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "status": "PROCESSED",
      "type": "TRANSACTION",
      "user": {
        "id": "553e8400-e29b-41d4-a716-436251480111",
        "name": "Loja Exemplo",
        "email": "contato@lojaexemplo.com"
      },
      "origin": "USER",
      "filters": {
        "startDate": "2026-03-06T00:00:00.000Z",
        "endDate": "2026-03-06T23:59:59.999Z",
        "status": ["PAID"],
        "paymentMethod": ["PIX"]
      },
      "file": {
        "key": "report-2026-03-06-553e8400-e29b-41d4-a716-436251480000-CSV",
        "isPrivate": true,
        "url": "signed-url"
      },
      "expirationDate": null,
      "errorMessage": null,
      "createdAt": "2026-03-06T12:49:04.681Z",
      "updatedAt": "2026-03-06T12:49:04.681Z"
    }
  ]
}

Errores Posibles

Código	Descripción	Solución
401	Credenciales inválidas	Verifique sus credenciales
403	Sin permiso/autorización	Contacte al soporte
422	Datos inválidos o faltantes	Verifique el formato de los datos
422	Validaciones	Contacte al soporte
500	Error interno	Contacte al soporte