Consultar Informe

Utilice este endpoint para consultar un informe por su id.

Entornos Disponibles

Producción

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

Endpoint

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

Path Params

Nombre	Tipo	Obligatorio	Descripción	Validaciones
id	string (UUID v4)	Sí	Identificador del informe	Debe ser un UUID v4 válido

Ejemplo de Solicitud

cURL

curl --request GET \
--url https://api.gateway.com.br/core/report/553e8400-e29b-41d4-a716-436251480000 \
--header 'Authorization: Bearer su-token-jwt'

JavaScript

const response = await fetch('https://api.gateway.com.br/core/report/553e8400-e29b-41d4-a716-436251480000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer su-token-jwt'
  }
});
const data = await response.json();

Respuesta Exitosa

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

Sub-Objetos

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

{
  "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
404	Registro no encontrado	Verifique el id enviado
422	Datos inválidos o faltantes	Verifique el formato de los datos
422	Validaciones	Contacte al soporte
500	Error interno	Contacte al soporte