Consultar Pago
Visión General
Este endpoint recupera información detallada de un pago Bre-B específico mediante su identificador único (payment_id
). Incluye metadatos como: Estado del pago, dirección (OUTGOING / INCOMING), monto, destinatario, fechas de creación y actualización.
Detalles del Endpoint
Parámetro | Descripción |
---|---|
Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/payments/breb/{payment_id} |
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
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/payments/breb/da2c2021-4f2c-42dd-8abd-1b91aeb20119' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>
Cuerpo de la Respuesta
- Código HTTP: 200 OK
Ejemplo de Respuesta
14
14
{
"created_at": "2025-09-10T16:44:10.250Z",
"status": "PENDING",
"id": "2b979ca8-c8d5-46ae-94db-5a4b780977b5",
"direction": "OUTGOING",
"updated_at": "2025-09-10T16:44:10.250Z",
"account_id": "83701eea-82b8-497d-9aa4-ae7704433a2d",
"reference": "Dispersion a merchant ABC",
"amount": {
"currency": "COP",
"value": "1000"
},
"breb_recipient_id": "6ba84442-21a3-4207-9ca9-53972855b0a2"
}
Errores Comunes y Manejo
Código HTTP | Significado | Descripción |
---|---|---|
400 | Bad Request | payment_id malformado o solicitud inválida. |
401 | Unauthorized | Token Bearer ausente, expirado o sin alcance paas.core.breb_payments.get . |
403 | Forbidden | El solicitante no tiene permisos para obtener este pago. |
404 | Not Found | No existe un pago con el payment_id proporcionado. |
500 | Server Error | Error inesperado en el servidor; reintente o contacte soporte. |
Buenas Prácticas
- Registra siempre los campos id, status y reference al consultar un pago, para efectos de conciliación y trazabilidad.
- Combínalo con Listar Pagos (GET /payments/breb) para monitorear operaciones por lotes o transacciones de múltiples clientes.
- Implementa validaciones en tu sistema para alertar cuando un pago permanezca en estado
PENDING
por más tiempo del esperado. - Usa
updated_at
para detectar cambios de estado relevantes en el ciclo de vida del pago.