Llaves Bre-B
En la API firmada, el destino de una dispersión se indica siempre con la llave (keyType + keyValue); el gateway la resuelve internamente.
Tipos de llave Bre-B
Sección titulada «Tipos de llave Bre-B»| Tipo | Formato del keyValue |
|---|---|
ID | Documento: hasta 18 alfanuméricos, sin guiones ni espacios |
PHONE | Celular: 10 dígitos, empieza por 3 |
EMAIL | Correo: máx 92 caracteres (30 antes del @, 61 después) |
ALPHA | Alias: @ + 5–20 alfanuméricos (6–21 caracteres en total) |
BCODE | Código de comercio: 10 dígitos, empieza por 00 |
keyType es obligatorio en la dispersión: no distingue mayúsculas y normaliza mobile / MOBILE → PHONE. El formato de keyValue se valida contra su tipo antes de llamar a la red o retener saldo; un valor inválido responde 400 con el detalle, y un keyType fuera del enum responde 400 con la lista de valores permitidos.
Validar una llave
Sección titulada «Validar una llave»POST /v1/co/breb/validate-key
Verifica que una llave exista y esté activa, y opcionalmente compara datos del titular/cuenta sin exponer información personal: cada campo enviado responde MATCH / NO MATCH.
{ "keyType": "PHONE", "keyValue": "3001234567", "owner": { "name": "MARIA FERNANDA G." }}Response 200 OK:
{ "keyType": "PHONE", "keyValue": "3001234567", "participant": { "name": "MATCH" }, "account": null, "owner": { "name": "MATCH" }}Si la llave no existe o no está activa, responde 404.
Errores
Sección titulada «Errores»| Código | Causa |
|---|---|
400 | keyType fuera del enum o keyValue con formato inválido |
403 | Servicio Bre-B no habilitado, o producción no habilitada para tu cuenta |
404 | Llave no encontrada o no activa |
409 | Onboarding incompleto — contacta con soporte |
422 | Bre-B rechazó la operación |
502 | Bre-B no disponible — reintenta |