Integración BReB
Consultar llave de cliente
Busca la llave (correo, celular o cédula) con la que un cliente está registrado en el sistema. Es como buscar un contacto en el celular — si existe, te muestra toda su información; si no existe, te avisa que no lo encontró.
¿Cuándo usarlo? Cuando quieres verificar si un cliente ya está registrado antes de enviarle una transferencia, o cuando necesitas los datos de la cuenta vinculada a una llave.
{BASE_URL}/breb/get-keyParámetros
| Campo | Tipo | Descripción | Req. |
|---|---|---|---|
channel | string | Por dónde se hace la operación. Como decirle al banco si vas en persona o por app. Ej: "REDESALIADAS", "MOVIL", "WEB". | Sí |
sourceService | string | Servicio origen de la petición. Ej: "PEX". | Sí |
user | string | Nombre del operador o usuario del sistema que hace la consulta. Ej: "jcano". | Sí |
identification | string | Número de cédula del cliente a consultar. El mismo que te piden en cualquier banco. Ej: "1144134800". | Sí |
typeIdentification | string | Tipo de documento. "CC" para cédula de ciudadanía. | Sí |
ip | string | Dirección IP del dispositivo. Como la dirección de tu casa, pero para el celular o computador. Ej: "192.168.0.1". | Sí |
purpose | string | Propósito de la consulta. Ej: "Source". | Sí |
uuid | string | Identificador único de la sesión o dispositivo. Como el número de serie de un celular. Ej: "a1b2c3d4e5f67890". | Sí |
mac | string | Dirección MAC del dispositivo. Un código único del hardware. Ej: "08:BD:01:00:00:00". | Sí |
platform | string | Sistema operativo del dispositivo. Ej: "iOS", "Android". | Sí |
trademark | string | Marca del dispositivo. Ej: "Apple", "Samsung". | Sí |
geoLocation | string | Ubicación GPS del dispositivo. Como cuando Rappi te pide activar la ubicación. Ej: "4.710989,-74.072092". | No |
simDeviceId | string | ID del SIM del dispositivo. Ej: "02ba0c1e". | No |
simOperator | string | Operador de telefonía. Ej: "Movistar", "Claro". | No |
serialDevice | string | Número serial del dispositivo. Ej: "01bb90c1d". | No |
simCellNumber | string | Número de celular de la SIM. Ej: "3123456789". | No |
simSerialNumber | string | Número serial de la SIM. Ej: "02ba0c1e". | No |
userAgentString | string | Información del navegador o app. Se genera automáticamente. Ej: "Mozilla/5.0 (iPhone...)". | No |
versionPlatform | string | Versión del sistema operativo. Ej: "13". | No |
model | string | Modelo del dispositivo. Ej: "iPhone 15". | No |
Ejemplo de petición
{
"channel" : "REDESALIADAS",
"sourceService" : "PEX",
"user" : "jcano",
"identification" : "1144134800",
"typeIdentification": "CC",
"ip" : "192.168.0.1",
"purpose" : "Source",
"uuid" : "a1b2c3d4e5f67890",
"mac" : "08:BD:01:00:00:00",
"platform" : "iOS",
"trademark" : "Apple",
"model" : "iPhone 15",
"geoLocation" : "4.710989,-74.072092",
"versionPlatform" : "13"
}Respuestas
| Código | Descripción |
|---|---|
| 200 | Llave encontrada. Retorna los datos del titular y su cuenta vinculada. |
| 400 | Datos inválidos. Algún campo está mal escrito o le falta información. |
| 404 | Llave no encontrada. El cliente no tiene llave registrada en el sistema. |
POSTLlave DinámicaNUEVO
Antes de iniciar un cobro mediante Llave Dinámica debes reservar la transacción en el endpoint de reservas. La reserva devuelve un identificador único y temporal (key.value) ligado a un monto exacto: el pagador transfiere a esa llave y la plataforma concilia automáticamente.
POSTRegistrar llave
Crea una nueva llave para un cliente — puede ser su correo, celular o cédula — y la vincula a su cuenta bancaria. Es como inscribirse a Nequi por primera vez: das tu número de celular y lo atan a tu cuenta.