Integración BReB
Registrar llave de cliente
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.
¿Cuándo usarlo? La primera vez que un cliente quiere recibir transferencias usando su correo, celular o cédula como identificador.
{BASE_URL}/breb/register-keyParámetros
| Campo | Tipo | Descripción | Req. |
|---|---|---|---|
channel | string | Canal de la operación. Ej: "MOVIL". | Sí |
sourceService | string | Servicio origen. Ej: "MEX". | Sí |
identification | string | Número de cédula del cliente. Ej: "80009330". | Sí |
typeIdentification | string | Tipo de documento. "CC" para cédula. | Sí |
numberAccount | string | Número de cuenta bancaria que se vincula a la llave. Ej: "862000034". | Sí |
processKeyCustomer | string | Tipo de proceso. Para registrar nuevo usar "NEWR". | Sí |
typeKeyCustomer | string | Tipo de llave: "E" = email, "P" = phone (celular), "NRIC" = cédula. | Sí |
valueKeyCustomer | string | El valor de la llave — el correo, el celular o la cédula. Ej: "rolozadag@gmail.com". | Sí |
typeAccount | string | Tipo de cuenta: "AH" = ahorros, "CC" = corriente. | Sí |
subTypeAccount | string | Subtipo de cuenta. Ej: "DE" para depósito electrónico. | Sí |
receptorNode | string | Nodo receptor en la red ACH. Ej: "VIS". | Sí |
sourceTypeAccountDescription | string | Descripción del tipo de cuenta. Ej: "Ahorros a la Vista". | Sí |
businessName | string | Nombre del negocio o empresa. Ej: "Cliente Test Nuevo". | Sí |
firstName | string | Primer nombre del cliente. Ej: "RENE". | Sí |
surName | string | Primer apellido del cliente. Ej: "LOZADA". | Sí |
secondSurName | string | Segundo apellido. Si no tiene, enviar "null". | No |
user | string | Operador que realiza el registro. Ej: "rene". | Sí |
Ejemplo de petición
{
"channel" : "MOVIL",
"sourceService" : "MEX",
"identification" : "80009330",
"typeIdentification" : "CC",
"numberAccount" : "862000034",
"processKeyCustomer" : "NEWR",
"typeKeyCustomer" : "E",
"valueKeyCustomer" : "rolozadag@gmail.com",
"typeAccount" : "AH",
"subTypeAccount" : "DE",
"receptorNode" : "VIS",
"sourceTypeAccountDescription": "Ahorros a la Vista",
"businessName" : "Cliente Test Nuevo",
"firstName" : "RENE",
"surName" : "LOZADA",
"secondSurName" : "null",
"user" : "rene"
}Respuestas
| Código | Descripción |
|---|---|
| 201 | Llave creada exitosamente. El cliente ya puede recibir transferencias con su correo/celular/cédula. |
| 400 | Datos inválidos. Revisa los campos obligatorios. |
| 409 | La llave ya existe. Este correo o celular ya está registrado — no se puede duplicar. |
POSTConsultar llave
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ó.
PUTActualizar llave
Modifica los datos de una llave que ya existe. Por ejemplo, si el cliente cambió de correo o quiere actualizar el nombre. Es como editar un contacto guardado en el celular.