Primeros pasos

Paginación

Los listados se recorren con limit y offset; los eventos, con un cursor por número de secuencia.


Hay dos formas de paginar, según la ruta.

RutasParámetrosOrdenTrae total
RutasGET /v1/customersParámetroslimit (1 a 200, por defecto 50), offsetOrdenDel más nuevo al más antiguoTrae totalSí
RutasGET /v1/depositsParámetroslimit (1 a 200, por defecto 50), offset, beforeOrdenDel más reciente al más antiguoTrae totalSí
RutasGET /v1/eventsParámetrosafter, before, order, limit (1 a 200, por defecto 100)OrdenPor seq, ascendente por defectoTrae totalNo
RutasGET /v1/customers/{id}/depositsParámetrosNingunoOrdenLos últimos 100Trae totalNo

Listados con limit y offset#

total es el número de registros que cumplen los filtros, no el tamaño de la página. Sigue pidiendo mientras offset + limit < total.

curl "https://api.pasarela.hi-g.io/v1/deposits?limit=50&offset=50&status=settled" \
  -H "x-api-key: sk_test_4f9c…"

Como el orden es del más reciente al más antiguo, un depósito nuevo empuja a los demás una posición. Usa before (fecha ISO 8601 en UTC, terminada en Z) para congelar el conjunto mientras lo recorres.

Eventos por secuencia#

Cada evento tiene un seq creciente. Guarda el último que procesaste y pide lo que sigue con after. Cuando la respuesta trae menos eventos que limit, ya estás al día. seq es único en toda la plataforma, así que para tu empresa puede tener saltos: no cuentes con que sea consecutivo.

curl "https://api.pasarela.hi-g.io/v1/events?after=34&limit=200" \
  -H "x-api-key: sk_test_4f9c…"

Para ver lo más reciente primero (por ejemplo en una pantalla de actividad) usa order=desc y avanza con before=<seq más bajo recibido>.