Autenticación
OAuth 2.0 client credentials para la API de Bre-B Participant.
La API de Bre-B Participant usa OAuth 2.0 client credentials para autenticación. A diferencia de Banking y Core, que también aceptan API keys estáticas, Bre-B requiere que intercambies un client ID y un secret por un access token de corta duración, y luego adjuntes ese token a cada llamada. El token expira; tu código lo refresca automáticamente antes de que lo haga.
Si ya leíste api-standards/authentication, esta página solo agrega lo específico de Bre-B: el endpoint de intercambio de tokens, la vida útil del token y el procedimiento de rotación.
Esta página es un esqueleto de autenticación. La versión completa documentará el request y la respuesta de intercambio de tokens, el manejo de errores y los patrones recomendados de cliente.
Antes de empezar
Necesitas:
- Un acuerdo de Bre-B participant con Mono.
- Credenciales de cliente (client ID y client secret) emitidas por Mono para tu tenant.
- La URL base del participant para tu entorno (sandbox o producción).
Intercambio de tokens
Aquí se documentarán el request completo de intercambio de tokens, la respuesta y la estrategia de refresh. Consulta la referencia de la API de autenticación de Bre-B Participant para el contrato del endpoint.
Enviando el token
Authorization: Bearer <your_access_token>Scopes
Un scope es un permiso individual asignado a un access token. Pide los scopes más acotados que necesite tu integración, separados por espacios en la solicitud de token. Cada recurso tiene dos scopes:
- El scope sin sufijo, como
collections, autoriza todas las acciones sobre ese recurso. - El scope
:readonlyautoriza solo lecturas.
| Scope | Autoriza |
|---|---|
outgoing_transfers | Todos los permisos sobre transferencias salientes |
outgoing_transfers:readonly | Leer transferencias salientes |
target_resolutions | Resolver llaves Bre-B y leer sus resoluciones |
target_resolutions:readonly | Leer resoluciones de target |
target_discoveries | Descubrir llaves Bre-B y leer el catálogo bancario |
target_discoveries:readonly | Leer el catálogo bancario |
collections | Todos los permisos sobre recaudos |
collections:readonly | Leer recaudos |
tenant_accounts | Todos los permisos sobre cuentas tenant |
tenant_accounts:readonly | Leer cuentas tenant |
Una llave Bre-B es un alias, como un número de celular, que apunta a una cuenta bancaria.
Scopes de descubrimiento de llaves
Usa target_discoveries para encontrar la llave Bre-B de un beneficiario a partir de sus datos de identidad y de cuenta, cuando no conoces la llave exacta. Usa target_resolutions cuando ya conoces la llave y llamas a
POST /api/v1/targets/resolve, y outgoing_transfers cuando creas el pago.
Consulta el flujo de descubrimiento de
llaves para ver la
secuencia completa.
Fallas
| Código | Significado |
|---|---|
401 Unauthorized | Token faltante, expirado o revocado — refréscalo. |
403 Forbidden | Token válido pero sin el scope para este endpoint. |
Rotando credenciales
Los tokens expiran automáticamente; la rotación en el sentido operativo significa rotar el client secret usado para obtenerlos. Rota el client secret al menos cada 90 días e inmediatamente después de cualquier sospecha de exposición.