Ir al contenido

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.

TipoFormato del keyValue
IDDocumento: hasta 18 alfanuméricos, sin guiones ni espacios
PHONECelular: 10 dígitos, empieza por 3
EMAILCorreo: máx 92 caracteres (30 antes del @, 61 después)
ALPHAAlias: @ + 5–20 alfanuméricos (6–21 caracteres en total)
BCODECó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.

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": { "identification_number": "1020304050" }
}

Dentro de owner se compara el documento del titular (identification_number); un campo no admitido como owner.name responde 422 con providerStatus: 400.

Response 200 OK:

{
"keyType": "PHONE",
"keyValue": "3001234567",
"participant": null,
"account": null,
"owner": { "identification_number": "MATCH" }
}

Si la llave no existe o no está activa, responde 404.

CódigoCausa
400keyType fuera del enum o keyValue con formato inválido
403Servicio Bre-B no habilitado, o producción no habilitada para tu cuenta
404Llave no encontrada o no activa
409Onboarding incompleto — contacta con soporte
422Bre-B rechazó la operación
502Bre-B no disponible — reintenta