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 (OUTGOING / INCOMING), destinatario, monto, referencias para conciliación y monitoreo.
Detalles del Endpoint
Parámetro | Descripción |
---|---|
Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/payments/breb |
Método | GET |
Encabezados | Content-Type: application/json, Authorization |
Autenticación | Token de Acceso (Bearer Token) |
Cuerpo de la Solicitud
Este endpoint no requiere cuerpo de solicitud (Request Body).
Ejemplo de Solicitud
2
2
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/payments/breb' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
Cuerpo de la Respuesta
- Código HTTP: 200 OK
Ejemplo de Respuesta
24
24
{
"pagination_info": {
"first_request_timestamp": "2025-09-10T21:56:34.589Z",
"current_page": 1,
"total_pages": 1,
"total_elements": 1
},
"payments": [
{
"status": "PENDING",
"id": "2b979ca8-c8d5-46ae-94db-5a4b780977b5",
"direction": "OUTGOING",
"created_at": "2025-09-10T16:44:10.250Z",
"account_id": "83701eea-82b8-497d-9aa4-ae7704433a2d",
"breb_recipient_id": "6ba84442-21a3-4207-9ca9-53972855b0a2",
"amount": {
"currency": "COP",
"value": "1000"
},
"updated_at": "2025-09-10T16:44:10.250Z",
"reference": "Dispersion a merchant ABC"
}
]
}
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_info
para 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.