Crear Informe

Utilice este endpoint para crear una solicitud de informe.

Entornos Disponibles

Producción

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

Endpoint

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

Body Params

Campo	Tipo	Obligatorio	Descripción	Validaciones
type	string (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES	Sí	Tipo del informe	Debe ser un enum válido; ACCOUNT y ACCOUNT_FINANCIAL_SUMMARY exigen un usuario con rol de manager
filters	object	Sí	Filtros del informe (ver Sub-Objeto Filters)	Debe ser un objeto no vacío

⚠️ ACCOUNT y ACCOUNT_FINANCIAL_SUMMARY exigen manager

Estos dos tipos de informe solo pueden ser solicitados por un usuario con rol de manager. Una cuenta sin ese rol recibe 403 al intentar generarlos.

Sub-Objetos

Filters

ℹ️ Fechas en ISO

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

Ejemplo:

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

⚠️ Intervalo máximo para WALLET_DAILY_BALANCES

Cuando type es WALLET_DAILY_BALANCES, el intervalo entre startDate y endDate no puede superar los 60 días.

Campo	Tipo	Obligatorio	Descripción	Validaciones
startDate	string	Sí	Fecha inicial del filtro	Debe ser una ISO date string con hora
endDate	string	Sí	Fecha final del filtro	Debe ser una ISO date string con hora; si type es WALLET_DAILY_BALANCES, el intervalo entre startDate y endDate debe ser de 60 días como máximo
storeId	string (UUID v4)	No	Identificador de la tienda	Opcional (envíelo si desea filtrar)
userId	string (UUID v4)	No	Identificador del usuario	Opcional (envíelo si desea filtrar)
status	string[] (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKED, PROCESSING, PROCESSED, CANCELED, REJECTED, APPEALED, APPROVED	No	Estados para filtrar	Debe ser un arreglo no vacío y sin duplicados
paymentMethod	string[] (enum) - PIX	No	Métodos de pago	Debe ser un arreglo no vacío y sin duplicados
acquirer	string[]	No	Adquirentes del informe	Debe ser un arreglo no vacío y sin duplicados

Ejemplo de Solicitud

cURL

curl --request POST \
--url https://api.gateway.com.br/core/report \
--header 'Authorization: Bearer su-token-jwt' \
--header 'Content-Type: application/json' \
--data '{
  "type": "TRANSACTION",
  "filters": {
    "startDate": "2026-03-06T00:00:00.000Z",
    "endDate": "2026-03-06T23:59:59.999Z"
  }
}'

JavaScript

const response = await fetch('https://api.gateway.com.br/core/report', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer su-token-jwt',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'TRANSACTION',
    filters: {
      startDate: '2026-03-06T00:00:00.000Z',
      endDate: '2026-03-06T23:59:59.999Z'
    }
  })
});
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)

Ejemplo de Respuesta

{
  "id": "553e8400-e29b-41d4-a716-436251480000",
  "status": "PENDING",
  "type": "TRANSACTION"
}

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