Paginación
Introducción
Al recuperar grandes volúmenes de datos desde la API de Passport, la paginación permite optimizar el rendimiento y mejorar el manejo de la información. Esta guía explica cómo está estructurado el objeto pagination_info y cómo implementar paginación en las solicitudes a la API.
Visión General de la Paginación
La paginación permite dividir grandes conjuntos de resultados en páginas más pequeñas y manejables. El objeto pagination_info proporciona los metadatos de la respuesta paginada.
Ejemplo de Respuesta con Paginación
"pagination_info": { "total_elements": 21, "first_request_timestamp": "2023-03-29T02:12:15", "total_pages": 2, "current_page": 1}Campos del Objeto de Paginación
| Campo | Tipo | Descripción |
|---|---|---|
| total_elements | Integer | Número total de elementos disponibles en todas las páginas. |
| first_request_timestamp | String (ISO 8601) | Marca de tiempo en la que se realizó la primera solicitud. |
| total_pages | Integer | Número total de páginas disponibles. |
| current_page | Integer | Número de la página correspondiente a la respuesta actual. |
La API calcula automáticamente el número total de páginas con base en la cantidad total de elementos y el tamaño definido por página.
Solicitud de Datos Paginados
Para solicitar datos paginados, incluye los parámetros de paginación soportados en la solicitud.
curl --location --request GET 'https://api.paas-sandbox.co.passportfintech.com/accounts' \--header 'Accept: application/json' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'Todos los endpoints tipo (GET) siempre retornarán un objeto de paginación.
Ejemplo de Respuesta con Paginación
{ "accounts": [ { "created_at": "2025-02-27T12:00:41.881Z", "updated_at": "2025-02-27T12:00:35.772Z", "customer_id": "caa846a4-5b72-406e-915d-ff617980309a", "account_number": "880830185", "available_balance": { "currency": "COP", "value": "90000000000000000" }, "pending_balance": { "currency": "COP", "value": "0" }, "account_name": "Individual Low Value Account", "bank_name": "BANCO COOPERATIVO COOPCENTRAL", "account_status": "ACTIVE", "id": "f8e5fe47-3f91-4338-a764-71fcc7e9c707", "account_type": "LOW_VALUE" }, { "created_at": "2025-02-27T15:47:28.282Z", "updated_at": "2025-02-27T15:47:24.233Z", "customer_id": "d9782bf2-5a7d-47fa-9ae7-18b33e6869e6", "account_number": "880360913", "available_balance": { "currency": "COP", "value": "90000000000000000" }, "pending_balance": { "currency": "COP", "value": "0" }, "account_name": "Individual Low Value Account", "bank_name": "BANCO COOPERATIVO COOPCENTRAL", "account_status": "ACTIVE", "id": "63219dec-7f5d-4065-910f-f4ad60a5dd16", "account_type": "LOW_VALUE" } ], "pagination_info": { "total_pages": 2, "total_elements": 4, "first_request_timestamp": "2025-03-06T13:08:40.510Z", "current_page": 1 }}