Listar Cuentas

Visión General

Este endpoint permite crear un Cliente (Customer) dentro de la API de Passport proporcionando los datos de identificación necesarios. Una solicitud exitosa retorna el ID del cliente y la información de confirmación del recurso creado.

Detalles del Endpoint

Parámetro	Descripción
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/accounts
Método	GET
Encabezados	Authorization
Autenticación	Token de Acceso (Bearer Token)

Este endpoint retorna todas las cuentas vinculadas a la entidad autenticada.

Parámetros de Consulta

Parámetros de Paginación

Parámetro	Descripción
page_params.page_size	Cantidad de registros a retornar por página.
page_params.page_number	Número de página a consultar.
page_params.first_request_timestamp.seconds	Segundos UTC desde Unix epoch (`1970-01-01T00:00:00Z`). Debe estar entre `0001-01-01T00:00:00Z` y `9999-12-31T23:59:59Z` (inclusive).
page_params.first_request_timestamp.nanos	Fracción en nanosegundos (0 a 999,999,999). Debe ser un valor no negativo y representa la fracción de segundo con resolución de nanosegundos.

Parámetros de Ordenamiento

Parámetro	Descripción
order_params.order_key	Campo utilizado para ordenar los resultados.
order_params.order_direction	Dirección del ordenamiento. Valores permitidos: `ORDER_DIRECTION_ENUM_UNSPECIFIED`, `ASC`, `DESC`.

Filtros de Cuentas

Parámetro	Descripción
customer_id	Filtra por el identificador del cliente asociado a la cuenta.
account_id	Filtra por el identificador único de la cuenta.
status	Filtra por el estado de la cuenta (por ejemplo, activa, inactiva).
account_type	Filtra por el tipo de cuenta (por ejemplo, ahorros, ordinaria).
account_number	Filtra por el número de cuenta.

Cuerpo de la Solicitud

No se requiere cuerpo en la solicitud para este endpoint.

Ejemplo de Solicitud

JSON
    
 
curl --location --request GET 'https://api.paas.sandbox.co.passportfintech.com/v1/accounts' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data ''
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK
Retorna los datos de todas las cuentas creadas junto con sus IDs únicos.

Ejemplo de Respuesta

JSON
    
 
{
    "accounts": [
        {
            "updated_at": "2025-10-09T17:41:23.179Z",
            "pending_balance": {
                "value": "0",
                "currency": "COP"
            },
            "customer_id": "db7e89e7-59d8-4ab1-b675-a2ae52c3339e",
            "account_type": "ORDINARY",
            "status": "ACTIVE",
            "account_number": "88827643001",
            "created_at": "2025-10-09T10:40:29.966Z",
            "available_balance": {
                "value": "90000000000000000",
                "currency": "COP"
            },
            "id": "6c23f053-0e1a-46b4-b902-97ba47e351bc"
        }
    ],
    "pagination_info": {
        "first_request_timestamp": "2025-10-09T17:43:22.10Z",
        "current_page": 1,
        "total_pages": 1,
        "total_elements": 1
    }
}
Copy

available_balance representa los fondos disponibles para su uso inmediato, pending_balance refleja transacciones que aún están en proceso de liquidación.

Errores Comunes y Manejo

Código HTTP	Significado	Descripción
400 Bad Request	Datos inválidos	Faltan campos requeridos o contienen valores incorrectos.
401 Unauthorized	Token inválido	El token de acceso ha expirado o es inválido.
403 Forbidden	Acceso denegado	La solicitud no está autorizada para listar las cuentas.
500 Server Error	Error del servidor	Ocurrió un error inesperado al recuperar las cuentas.

Buenas Prácticas

Asegúrate de que el token de autenticación sea válido antes de realizar la solicitud.
Utiliza paginación si estás trabajando con grandes volúmenes de cuentas.
Supervisa los saldos de cuenta para evitar errores de fondos insuficientes al realizar transacciones.

Última actualización el