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) |
Cuerpo de la Solicitud
- No requiere cuerpo de solicitud.
Ejemplo de Solicitud
2
2
curl --location 'https://api.paas.sandbox.co.passportfintech.com/v1/payments' \--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \Cuerpo de la Respuesta
- Código HTTP: 200 OK
Ejemplo de Respuesta
114
114
{ "pagination_info": {}, "payments": []}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 (OUTGOING o INCOMING) 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.