Esta sección requiere que Mouv habilite el modo agregador para tu empresa. Escribinos a hola@vectora.com.co para activarlo. Sin la activación, los endpoints responden
403 AGGREGATOR_NOT_ENABLED.Cómo funciona
- Emitís una llave por cliente con
POST /breb/collect-keys, mandando el nombre de tu cliente y tuexternalId(el ID de ese cliente en TU sistema). Mouv deriva la llave del nombre — por ejemploPanadería La Espiga→@PANADERIALAESPIG3456— vos nunca inventás el valor. - Tu cliente cobra compartiendo su llave o su código QR (
POST /breb/collect-keys/{id}/qr). Cualquier persona le paga desde su app bancaria por Bre-B. - El dinero se acredita a TU saldo en Mouv (vos sos nuestro cliente; tus clientes son tuyos). Cada pago queda marcado con la llave que lo recibió.
- Conciliás por polling con
GET /deposits?rail=BREB&externalId=...: cada depósito trae el objetobrebKeycon tuexternalId— sabés a qué cliente tuyo pertenece cada peso, con nombre, documento y banco del pagador.
Idempotencia (importante)
POST /breb/collect-keys es idempotente por externalId: si reintentás con el mismo externalId (timeout, reintento de tu job, doble click), recibís 200 con la llave ya existente — jamás se crea una segunda llave para el mismo cliente. Diseñá tu integración para reintentar con confianza.
Loop de alta masiva (ejemplo: 1.000 clientes)
- Límite de creación: 30 llaves por minuto (el resto de tu lote espera y reintenta — el
externalIdidempotente hace el reintento gratis). 1.000 llaves ≈ 35 minutos. - Si un nombre colisiona en la red nacional Bre-B, Mouv intenta automáticamente hasta 3 variantes; si todas están tomadas recibís
409 KEY_TAKENcon las variantes intentadas — cambiá levemente el nombre y reintentá.
Conciliación por polling
Qué ve la persona que paga
El titular registrado de la cuenta en la red Bre-B es Vectora (la entidad regulada detrás de Mouv). La llave es lo que identifica a tu cliente — por eso lleva su nombre. Contale a tus clientes que compartan la llave o el QR con el nombre, y que el pagador puede verificarla antes de enviar.Baja de un cliente
DELETE /breb/collect-keys/{id} desactiva la llave (la llave deja de recibir pagos). La operación es idempotente y el histórico de recaudos de esa llave sigue disponible en GET /deposits.