Listar Pagos

Visión General

Este endpoint recupera una lista paginada de los pagos Bre-B asociados a los clientes de una entidad. Proporciona detalles como: Estado del pago, dirección, destinatario, monto, referencias para conciliación y monitoreo.

Detalles del Endpoint

Parámetro	Descripción
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/payments
Método	GET
Encabezados	Content-Type: application/json, Authorization
Autenticación	Token de Acceso (Bearer Token)

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`).
page_params.first_request_timestamp.nanos	Fracción en nanosegundos (0 a 999,999,999).

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 del Pago

Parámetro	Descripción
payment_id	Filtra por ID del pago.
customer_id	Filtra por ID del cliente.
account_id	Filtra por ID de la cuenta.
direction	Filtra por dirección del pago (por ejemplo, `INBOUND` / `OUTBOUND`).
key_value	Filtra por la llave Bre-B asociada al pago.
status	Filtra por estado del pago (por ejemplo.
qr_code_reference	Filtra por referencia del código QR.
type	Filtra por tipo de pago.
end_to_end_identification	Filtra por el ID único de la transacción en el ecosistema Bre-B.

Filtros del Remitente

Parámetro	Descripción
sender_type	Filtra por tipo de titular del remitente (por ejemplo, `INDIVIDUAL`, `BUSINESS`).
sender_name	Filtra por nombre del remitente.
sender_identification_type	Filtra por tipo de identificación del remitente (por ejemplo, `CC`, `NIT`).
sender_identification_number	Filtra por número de identificación del remitente.
sender_account_type	Filtra por tipo de cuenta del remitente.
sender_account_number	Filtra por número de cuenta del remitente.
sender_participant_name	Filtra por nombre del participante del remitente.
sender_participant_identification_number	Filtra por número de identificación del participante del remitente.

Filtros del Receptor

Parámetro	Descripción
receiver_type	Filtra por tipo de titular del receptor (por ejemplo, `INDIVIDUAL`, `BUSINESS`).
receiver_name	Filtra por nombre del receptor.
receiver_identification_type	Filtra por tipo de identificación del receptor (por ejemplo, `CC`, `NIT`).
receiver_identification_number	Filtra por número de identificación del receptor.
receiver_account_type	Filtra por tipo de cuenta del receptor.
receiver_account_number	Filtra por número de cuenta del receptor.
receiver_participant_name	Filtra por nombre del participante del receptor.
receiver_participant_identification_number	Filtra por número de identificación del participante del receptor.

Filtros por fecha de Actualización

Parámetro	Descripción
updated_at_after.seconds	Límite inferior de la fecha/hora de actualización, en segundos UTC desde Unix epoch.
updated_at_after.nanos	Fracción en nanosegundos para `updated_at_after` (0 a 999,999,999).
updated_at_before.seconds	Límite superior de la fecha/hora de actualización, en segundos UTC desde Unix epoch.
updated_at_before.nanos	Fracción en nanosegundos para `updated_at_before` (0 a 999,999,999).

Cuerpo de la Solicitud

No requiere cuerpo de solicitud.

Ejemplo de Solicitud

JSON
    
 
curl --location 'https://api.paas.sandbox.co.passportfintech.com/v1/payments' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK

Ejemplo de Respuesta

JSON
    
 
{
    "pagination_info": {...},
    "payments": [...]
}
Copy

Errores Comunes y Manejo

Código HTTP	Significado	Descripción
400	Bad Request	Parámetros inválidos o solicitud malformada.
401	Unauthorized	Token Bearer ausente, expirado o sin alcance `paas.core.breb_payments.list.get`.
403	Forbidden	El solicitante no tiene permisos para listar los pagos.
404	Not Found	No existen pagos para la entidad.
500	Server Error	Error inesperado en el servidor; reintente o contacte soporte.

Buenas Prácticas

Usa el objeto pagination_infopara recorrer historiales extensos de pagos.
Aprovecha el campo direction (OUTBOUND o INBOUND) para conciliaciones y liquidaciones.
Registra y audita los campos id, reference y updated_at en tus sistemas de monitoreo.
Combina con Obtener Detalle de un Pago (GET /payments/{id}) cuando necesites información más específica de una transacción.

Última actualización el