Dashboard

Utilice este endpoint para consultar los indicadores del dashboard.

Entornos Disponibles

Producción

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

Endpoint

• Método: GET
• Endpoint: /dashboard/user
• 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

Nombre	Tipo	Obligatorio	Descripción	Validaciones
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
timezone	string	No	Zona horaria usada en el filtro	Debe ser una timezone válida

Ejemplo de Solicitud

cURL

curl --request GET \
--url https://api.gateway.com.br/core/dashboard/user?startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z&timezone=America%2FSao_Paulo \
--header 'Authorization: Bearer su-token-jwt'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-06T00:00:00.000Z',
  endDate: '2026-03-06T23:59:59.999Z',
  timezone: 'America/Sao_Paulo'
});

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

Respuesta Exitosa

ℹ️ Varía según el tipo de cuenta

El retorno depende del AccountTypeEnum del usuario extraído del token.

• SELLER: Cuenta Vendedor
• ACCOUNT_MANAGER: Cuenta Account Manager
• GATEWAY: Cuenta Gateway
• IGAMING: Cuenta Transaccional

⚠️ Importante: Montos en Centavos

Todos los valores monetarios se devuelven en centavos. El saldo se calcula con cinco decimales, por la aplicación de las tarifas, así que en centavos puede venir con fracción: un saldo de R$ 8,488.15900 devuelve 848815.9.

Cuenta Vendedor

Campo	Tipo	Obligatorio	Descripción
transactionValue	number	Sí	Monto total de transacciones
balance	number	Sí	Saldo disponible
reserve	number	Sí	Monto en reserva
toReceive	number	Sí	Monto por recibir
transactionVolume	number	Sí	Cantidad de transacciones pagadas
transactionCreatedVolume	number	Sí	Cantidad de transacciones creadas
middleTicketValue	number	Sí	Ticket promedio
refundedVolume	number	Sí	Cantidad de transacciones reembolsadas
refundedPercentage	number	Sí	Porcentaje reembolsado
withdrawalRefundedValue	number	Sí	Monto total de retiros reembolsados
withdrawalRefundedVolume	number	Sí	Cantidad total de retiros reembolsados
withdrawalRefundedValueOnCreatedDate	number	Sí	Monto de retiros reembolsados en la fecha de creación
withdrawalRefundedVolumeOnCreatedDate	number	Sí	Cantidad de retiros reembolsados en la fecha de creación
frozenValue	number	No	Monto congelado
pendingDebits	number	Sí	Débitos pendientes
paymentMethods	object	Sí	Montos por método de pago (ver Sub-Objeto PaymentMethods)
indexes	object	Sí	Indicadores del período (ver Sub-Objeto Indexes)
orders	array	Sí	Totales por fecha (ver Sub-Objeto TotalsByDate)

Cuenta Account Manager

Campo	Tipo	Obligatorio	Descripción
transactionValue	number	Sí	Monto total de transacciones
balance	number	Sí	Saldo disponible
reserve	number	Sí	Monto en reserva
toReceive	number	Sí	Monto por recibir
transactionVolume	number	Sí	Cantidad de transacciones pagadas
transactionCreatedVolume	number	Sí	Cantidad de transacciones creadas
middleTicketValue	number	Sí	Ticket promedio
refundedVolume	number	Sí	Cantidad de transacciones reembolsadas
refundedPercentage	number	Sí	Porcentaje reembolsado
withdrawalRefundedValue	number	Sí	Monto total de retiros reembolsados
withdrawalRefundedVolume	number	Sí	Cantidad total de retiros reembolsados
withdrawalRefundedValueOnCreatedDate	number	Sí	Monto de retiros reembolsados en la fecha de creación
withdrawalRefundedVolumeOnCreatedDate	number	Sí	Cantidad de retiros reembolsados en la fecha de creación
frozenValue	number	No	Monto congelado
pendingDebits	number	Sí	Débitos pendientes
paymentMethods	object	Sí	Montos por método de pago (ver Sub-Objeto PaymentMethods)
indexes	object	Sí	Indicadores del período (ver Sub-Objeto Indexes)
orders	array	Sí	Totales por fecha (ver Sub-Objeto TotalsByDate)

Cuenta Gateway

Campo	Tipo	Obligatorio	Descripción
transactionValue	number	Sí	Monto total de transacciones
balance	number	Sí	Saldo disponible
reserve	number	Sí	Monto en reserva
transactionVolume	number	Sí	Cantidad de transacciones pagadas
transactionCreatedVolume	number	Sí	Cantidad de transacciones creadas
middleTicketValue	number	Sí	Ticket promedio
withdrawalRefundedValue	number	Sí	Monto total de retiros reembolsados
withdrawalRefundedVolume	number	Sí	Cantidad total de retiros reembolsados
withdrawalRefundedValueOnCreatedDate	number	Sí	Monto de retiros reembolsados en la fecha de creación
withdrawalRefundedVolumeOnCreatedDate	number	Sí	Cantidad de retiros reembolsados en la fecha de creación
pendingDebits	number	Sí	Débitos pendientes
frozenValue	number	No	Monto congelado
orders	array	Sí	Totales por fecha (ver Sub-Objeto TotalsByDate)

Cuenta Transaccional

Campo	Tipo	Obligatorio	Descripción
revenue	array	Sí	Ingresos por fecha (ver Sub-Objeto TotalsByDate)
expense	array	Sí	Gastos por fecha (ver Sub-Objeto TotalsByDate)
transactionVolume	number	Sí	Cantidad de transacciones pagadas
transactionCreatedVolume	number	Sí	Cantidad de transacciones creadas
middleTicketValue	number	Sí	Ticket promedio
deposit	number	Sí	Monto total de depósitos
withdrawals	number	Sí	Monto total de retiros
balance	number	Sí	Saldo disponible
averageDeposit	number	Sí	Depósito promedio
withdrawalRefundedValue	number	Sí	Monto total de retiros reembolsados
withdrawalRefundedVolume	number	Sí	Cantidad total de retiros reembolsados
withdrawalRefundedValueOnCreatedDate	number	Sí	Monto de retiros reembolsados en la fecha de creación
withdrawalRefundedVolumeOnCreatedDate	number	Sí	Cantidad de retiros reembolsados en la fecha de creación
frozenValue	number	Sí	Monto congelado
pendingDebits	number	Sí	Débitos pendientes

Sub-Objetos

PaymentMethods

Campo	Tipo	Obligatorio	Descripción
pixPaidValue	number	Sí	Monto pagado por PIX
pixGeneratedValue	number	Sí	Monto generado por PIX
pixPercentage	number	Sí	Porcentaje por PIX
cardsPaidValue	number	Sí	Monto pagado con tarjetas
cardsGeneratedValue	number	Sí	Monto generado con tarjetas
cardsPercentage	number	Sí	Porcentaje con tarjetas
billetPaidValue	number	Sí	Monto pagado con boletos
billetGeneratedValue	number	Sí	Monto generado con boletos
billetPercentage	number	Sí	Porcentaje con boletos

Indexes

Campo	Tipo	Obligatorio	Descripción
pixConversion	number	Sí	Conversión de PIX
billetConversion	number	Sí	Conversión de boleto
creditCardConversion	number	Sí	Conversión de tarjeta de crédito
preChargebackVolume	number	Sí	Cantidad de pre-chargebacks
preChargebackPercentage	number	Sí	Porcentaje pre-chargeback
chargebackVolume	number	Sí	Cantidad de chargebacks
chargebackPercentage	number	Sí	Porcentaje de chargeback
creditCardsRefusedVolume	number	Sí	Cantidad de tarjetas rechazadas
creditCardsRefusedPercentage	number	Sí	Porcentaje de tarjetas rechazadas
medVolume	number	No	Cantidad de MED
medPercentage	number	No	Porcentaje de MED

TotalsByDate

Campo	Tipo	Obligatorio	Descripción
date	string (ISO)	Sí	Fecha de referencia
total	number	Sí	Total del día

Ejemplo de Respuesta (Seller)

{
  "transactionValue": 150000,
  "balance": 50000,
  "reserve": 10000,
  "toReceive": 90000,
  "transactionVolume": 30,
  "transactionCreatedVolume": 40,
  "middleTicketValue": 5000,
  "refundedVolume": 1,
  "refundedPercentage": 3.3,
  "withdrawalRefundedValue": 1200,
  "withdrawalRefundedVolume": 3,
  "withdrawalRefundedValueOnCreatedDate": 800,
  "withdrawalRefundedVolumeOnCreatedDate": 2,
  "frozenValue": 2000,
  "pendingDebits": 1000,
  "paymentMethods": {
    "pixPaidValue": 60000,
    "pixGeneratedValue": 65000,
    "pixPercentage": 40,
    "cardsPaidValue": 70000,
    "cardsGeneratedValue": 75000,
    "cardsPercentage": 47,
    "billetPaidValue": 20000,
    "billetGeneratedValue": 25000,
    "billetPercentage": 13
  },
  "indexes": {
    "pixConversion": 92,
    "billetConversion": 65,
    "creditCardConversion": 78,
    "preChargebackVolume": 1200,
    "preChargebackPercentage": 0.8,
    "chargebackVolume": 500,
    "chargebackPercentage": 0.3,
    "creditCardsRefusedVolume": 3000,
    "creditCardsRefusedPercentage": 2.0,
    "medVolume": 200,
    "medPercentage": 0.1
  },
  "orders": [
    {
      "date": "2026-03-06",
      "total": 50000
    },
    {
      "date": "2026-03-07",
      "total": 100000
    }
  ]
}

Ejemplo de Respuesta (Gateway)

{
  "transactionValue": 120000,
  "balance": 40000,
  "reserve": 8000,
  "transactionVolume": 20,
  "transactionCreatedVolume": 25,
  "middleTicketValue": 6000,
  "withdrawalRefundedValue": 900,
  "withdrawalRefundedVolume": 2,
  "withdrawalRefundedValueOnCreatedDate": 500,
  "withdrawalRefundedVolumeOnCreatedDate": 1,
  "pendingDebits": 900,
  "frozenValue": 1500,
  "orders": [
    {
      "date": "2026-03-06",
      "total": 45000
    },
    {
      "date": "2026-03-07",
      "total": 75000
    }
  ]
}

Ejemplo de Respuesta (Cuenta Transaccional)

{
  "revenue": [
    {
      "date": "2026-03-06",
      "total": 90000
    },
    {
      "date": "2026-03-07",
      "total": 110000
    }
  ],
  "expense": [
    {
      "date": "2026-03-06",
      "total": 30000
    },
    {
      "date": "2026-03-07",
      "total": 35000
    }
  ],
  "transactionVolume": 18,
  "transactionCreatedVolume": 25,
  "middleTicketValue": 8000,
  "deposit": 200000,
  "withdrawals": 80000,
  "balance": 120000,
  "averageDeposit": 10000,
  "withdrawalRefundedValue": 700,
  "withdrawalRefundedVolume": 1,
  "withdrawalRefundedValueOnCreatedDate": 700,
  "withdrawalRefundedVolumeOnCreatedDate": 1,
  "frozenValue": 5000,
  "pendingDebits": 2500
}

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