Listar Historial de Saldo

Utilice este endpoint para listar el historial de saldo con filtros.

Entornos Disponibles

Producción

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

Endpoint

• Método: GET
• Endpoint: /wallet/ledger-entry
• 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
type	string[] (enum) - CREDIT, DEBIT	No	Lista de tipos para filtrar	Debe ser un arreglo no vacío y sin duplicados

Ejemplo de Solicitud

cURL

curl --request GET \
--url https://api.gateway.com.br/core/wallet/ledger-entry?type=DEBIT&startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z \
--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'
});
params.append('type', 'DEBIT');

const response = await fetch(`https://api.gateway.com.br/core/wallet/ledger-entry?${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

Campos del elemento en data

Campo	Tipo	Obligatorio	Descripción
id	string (UUID)	Sí	Identificador único
transactionId	string (UUID)	Sí	Identificador único de la transacción
amount	number	Sí	Monto en centavos, puede venir con fracción
balanceBefore	number	Sí	Saldo anterior en centavos, puede venir con fracción
balanceAfter	number	Sí	Nuevo saldo en centavos, puede venir con fracción
type	string (enum) - CREDIT, DEBIT	Sí	Tipo
description	string	Sí	Descripción del evento
date	string	Sí	Fecha del evento

Ejemplo de Respuesta

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "amount": 10000,
      "balanceBefore": 50000,
      "balanceAfter": 60000,
      "type": "CREDIT",
      "description": "Transaction payment",
      "date": "2026-03-06T12:49:04.681Z"
    },
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "amount": 1000,
      "balanceBefore": 60000,
      "balanceAfter": 59000,
      "type": "DEBIT",
      "description": "Transaction payment - Fee",
      "date": "2026-03-06T12:49:04.681Z"
    },
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "amount": 2000,
      "balanceBefore": 59000,
      "balanceAfter": 57000,
      "type": "DEBIT",
      "description": "Transaction payment - Reserve",
      "date": "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
500	Error interno	Contacte al soporte