Visión General
Este endpoint permite recuperar los detalles de una Llave Bre-B específica en la API de Passport usando la información base de la Llave: tipo de llave y valor de la llave.
Está pensado para cuando el Cliente realiza un pago único o esporádico al propietario de la Llave, por ejemplo en un Punto de Venta (POS) de un restaurante o en una compra en línea. No es necesario guardar un Recipiente, por lo que se necesitan menos llamadas de API para completar el Pago.
Detalles del Endpoint
| Parámetro | Descripción |
|---|---|
| Endpoint | https://api.paas.sandbox.co.passportfintech.com/v1/resolve-key |
| Método | POST |
| Encabezados | Authorization |
| Autenticación | Token de Acceso (Bearer Token) |
Cuerpo de la Solicitud
| Parámetro | Tipo | Restricciones | Obligatorio | Descripción |
|---|---|---|---|---|
| customer_id | UUID | Sí | ID único del Cliente que realiza la solicitud. | |
| key | Objeto | Sí | Objeto que almacena la información de la Llave. | |
| key_type | ENUM | Sí | Tipo de Llave Bre-B a resolver. Valores aceptados:
| |
| key_value | String | Sí | Valor de la Llave Bre-B a resolver. |
Ejemplo de Solicitud
curl --location --request POST 'https://api.paas.sandbox.co.passportfintech.com/v1/resolve-key' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \--data '{ "customer_id": "133009ae-cf5d-4140-a4e2-3f950aa5550f", "key": { "key_type": "PHONE", "key_value": "3123185778" }}'Cuerpo de la Respuesta
- Código HTTP: 200 OK
- Retorna los datos de la cuenta asociada al cliente junto con su ID único.
Ejemplo de Respuesta
{ "id": "4843d4f0-93d6-434e-92df-8b29a80f196f", "owner": { "identification_type": "NIT", "identification_number": "403364725", "first_name": "", "second_name": "", "first_last_name": "", "type": "BUSINESS", "business_name": "Merchant IRPFQ", "second_last_name": "" }, "key": { "key_type": "PHONE", "key_value": "3123185778" }, "customer_id": "5991657f-fcd2-4699-af98-7d980e24b245", "resolved_at": "2025-10-31T12:30:30.667Z", "participant": { "name": "Banco A", "identification_number": "837283743" }, "account": { "account_number": "88815573857", "account_type": "ORDINARY" }, "expires_at": "2025-10-31T13:00:30.667Z", "receptor_node": "VIS"}La respuesta confirma la traducción de la Llave Bre-B a la información financiera que debe presentarse al Cliente y garantiza el enrutamiento correcto de un posible Pago.
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 | No tienes permisos para resolver la llave. |
| 404 Not Found | Destinatario no Encontrado | No existe destinatario con el ID. |
| 500 Server Error | Error del servidor | Error inesperado al consultar los detalles de la cuenta. |
Buenas Prácticas
- Usa los datos recuperados para iniciar pagos Bre-B: utiliza el id de la respuesta anterior como
resolution_iddentro del cuerpo del Pago.