Crear llave Bre-B de un cliente
Asigna a un cliente su propia llave Bre-B para recibir transferencias en su billetera, y devuelve su QR.
POST
Crea una llave Bre-B a nombre de uno de tus clientes. Lo que le transfieran a esa llave entra directo al saldo de su billetera, que consultas con Saldo y Movimientos.
La respuesta trae también el QR de la llave, listo para mostrárselo al cliente.
Disponible para empresas con billeteras (Fintech as a service) activas. Si tu empresa no las tiene, el endpoint responde
403.Path
string
required
ID del cliente que va a recibir la llave. Crear cliente.
Body
string
required
Llave que quieres asignar, sin el
@. Mínimo 5 caracteres, y no puede estar registrada ya en Bre-B. Usa solo letras y números: Bre-B registra la llave solo con esos caracteres, y quien te transfiere la escribe con @ adelante (@juanperez). Siempre es una llave alfanumérica: si mandas solo números, queda como @3001234567 y no como una llave de celular o de cédula.QR de la llave
- Es estático: no lleva monto. Quien escanea escribe cuánto transfiere desde su app bancaria.
- Muestra el nombre de tu empresa, cortado a 19 caracteres. Es el mismo nombre que ve quien transfiere a la llave.
qr.imagees la imagen en base64 con su prefijodata:image/png;base64,, así que va directo en un<img>:
- El QR solo llega en esta respuesta. Guárdalo: hoy no hay un endpoint para volver a pedirlo.
qrpuede venir ennullsi el QR no se pudo generar. La llave queda creada igual y recibe transferencias.
Campos de respuesta
qr viene en null cuando el QR no se pudo generar. La llave sirve igual.
Errores de la llave
Además deEsta llave BreB ya existe, el 422 puede traer estos mensajes en errors.account_number. En los dos casos, pide otra llave:
Esta llave ya existe en Kamin. Por favor usa otra.Esta llave ya está registrada en otra entidad financiera.
Flujo
- Crea el cliente con Crear cliente, si todavía no existe.
- Llama a este endpoint con la llave que el cliente eligió.
- Muéstrale al cliente su llave (
external_id) y su QR (qr.image). - Lo que le transfieran entra a su billetera: consúltalo con Saldo y Movimientos.
- Para ver las llaves de un cliente, usa Cuentas del cliente.