Resolver Llave Bre-B

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ámetroDescripción
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/key-resolution
MétodoPOST
EncabezadosAuthorization
AutenticaciónToken de Acceso (Bearer Token)

Cuerpo de la Solicitud

ParámetroTipoRestriccionesObligatorioDescripción
customer_idUUIDID único del Cliente que realiza la solicitud.
keyObjetoObjeto que almacena la información de la Llave.
key_typeENUM

Tipo de Llave Bre-B a resolver. Valores aceptados:

ID: Número de documento.

PHONE: Número de teléfono móvil.

EMAIL: Correo electrónico.

ALPHA: Alfanumérica.

BCODE: Número comercial de entidad.

key_valueStringValor de la Llave Bre-B a resolver.

Ejemplo de Solicitud

JSON
Copy

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

JSON
Copy

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 HTTPSignificadoDescripción
400 Bad RequestDatos inválidosFaltan campos requeridos o contienen valores incorrectos.
401 UnauthorizedToken inválidoEl token de acceso ha expirado o es inválido.
403 ForbiddenAcceso denegadoNo tienes permisos para resolver la llave.
404 Not FoundDestinatario no EncontradoNo existe destinatario con el ID.
500 Server ErrorError del servidorError 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_id dentro del cuerpo del Pago.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard