> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onepay.la/llms.txt
> Use this file to discover all available pages before exploring further.

# Introducción

> Bre-B es el sistema de pagos inmediatos del Banco de la República de Colombia.

## ¿Qué es Bre-B?

Bre-B es el sistema de pagos inmediatos del **Banco de la República de Colombia**. Permite transferencias **24/7** entre personas y empresas usando **llaves digitales** (celular, identificación, correo o alias) en lugar de números de cuenta.

Con OnePay puedes integrar Bre-B para recibir y enviar dinero en segundos.

## Ejemplo Rápido

### Crear un pago Bre-B

```bash theme={null}
curl https://api.onepay.la/v1/breb \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "Content-Type: application/json" \
  -H "x-idempotency: breb-001" \
  -d '{
    "amount": 75000,
    "currency": "COP",
    "key_type": "phone",
    "key_value": "+573001234567",
    "description": "Pago de servicio",
    "customer_id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d"
  }'
```

**Tipos de llaves soportadas:**

| Tipo     | Formato                | Ejemplo            |
| -------- | ---------------------- | ------------------ |
| `phone`  | Celular con código +57 | `+573001234567`    |
| `email`  | Correo electrónico     | `juan@example.com` |
| `cedula` | Cédula de ciudadanía   | `1234567890`       |
| `alias`  | Alias personalizado    | `@miempresa`       |

**Respuesta:**

```json theme={null}
{
  "id": "9e5a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "amount": 75000,
  "amount_label": "$75.000",
  "currency": "COP",
  "status": "completed",
  "key_type": "phone",
  "key_value": "+573001234567",
  "description": "Pago de servicio",
  "customer_id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
  "completed_at": "2025-09-15T10:30:05.000000Z",
  "created_at": "2025-09-15T10:30:00.000000Z"
}
```

El pago se acredita **instantáneamente** en la cuenta del beneficiario asociada a la llave.

## Características principales

* **Disponibilidad 24/7**: Funciona todos los días del año, a cualquier hora
* **Interoperabilidad**: Conecta bancos, billeteras digitales y entidades financieras
* **Transferencias inmediatas**: Los fondos se acreditan en segundos
* **Identificadores simples**: Llaves fáciles de recordar en lugar de datos bancarios
* **Sin costo inicial**: Sin cobro por parte del Banco de la República durante los primeros tres años

## Cómo usar Bre-B con OnePay

### Cobros (Pay-ins)

Recibe pagos instantáneos usando llaves estáticas o dinámicas como método de cobro. Elimina esperas y procesos engorrosos para tus clientes.

### Pagos (Payouts)

Envía desembolsos, pagos masivos o nómina en tiempo real. Solo necesitas la llave del beneficiario.

### Integración

| Opción            | Descripción                                             |
| ----------------- | ------------------------------------------------------- |
| **Portal OnePay** | Usa Bre-B sin desarrollo técnico desde el administrador |
| **API OnePay**    | Integración directa para automatizar cobros y pagos     |

### Trazabilidad

* Cada transacción se registra con detalle completo
* Reportes exportables y conciliación automática

## Casos de uso

| Caso                   | Beneficio                               |
| ---------------------- | --------------------------------------- |
| Marketplaces           | Cobros instantáneos a vendedores        |
| Fintechs y billeteras  | Interoperabilidad total entre entidades |
| E-commerce             | Pagos rápidos y confirmación inmediata  |
| Nómina y pagos masivos | Dispersión en segundos                  |
| Remesas                | Acreditación inmediata                  |

## Disponibilidad

* **Julio 2025**: Inicio del registro de llaves Bre-B
* **Septiembre 2025**: Lanzamiento oficial (P2P y P2M)
* OnePay estará habilitado desde la fase inicial, tanto para cobros como para pagos

## Endpoints

| Método | Endpoint             | Descripción                |
| ------ | -------------------- | -------------------------- |
| `POST` | [/breb](create)      | Crear transacción Bre-B    |
| `GET`  | [/breb](list)        | Listar transacciones       |
| `GET`  | [/breb/{id}](detail) | Detalle de una transacción |
