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

# Stream de eventos en tiempo real (SSE)

> Abre una conexión `text/event-stream` que entrega en tiempo real todos los eventos de la cuenta — los mismos que viajan por webhook, sin que expongas un endpoint público.

Cada evento lleva `id:` (cursor monótono), `event:` (el tipo de evento) y `data:` (JSON con el mismo `event_id` del webhook, así ambos canales se cruzan).

Reconecta con el header `Last-Event-ID` (o `?last_event_id=`) y el servidor replaya lo que te perdiste antes de seguir en vivo. El `EventSource` nativo no puede mandar el header `Authorization`: usa `fetch` con `ReadableStream`.

El alcance sale de la credencial: una credencial de cuenta recibe sus propios eventos; una credencial org-admin con `ops:read` recibe el canal de toda la organización y puede acotarlo con `?account_id=`.

La conexión manda `: ping` cada 20s, revalida la sesión cada 60s (una sesión revocada cierra el stream con el evento de control `unauthorized`) y se cierra a los 30 minutos con un evento de control `reconnect`.



## OpenAPI

````yaml /openapi.es.yaml get /v1/events
openapi: 3.1.0
info:
  title: CBPay API
  version: '2.62'
  description: |
    CBPay es una plataforma de pagos multimoneda: payouts y cobros fiat
    en toda América Latina, transferencias internas, fondeo y retiros
    on-chain, y screening KYC. Cada cuenta mantiene cuatro saldos virtuales
    independientes — USDT (la moneda operativa), USDC, BTC y GOLD (gramos de
    oro fino) — convertibles a demanda con swaps.
    Los payouts y las comisiones de servicios pueden pagarse desde cualquiera
    de los cuatro saldos (`PUT /v1/settlement` u override por payout con
    `settlement_asset`), y los payins pueden auto-convertirse al asset que
    elijas (`default_payin_asset`).

    Todos los montos son strings decimales en la precisión de cada moneda (6
    decimales para USDT/USDC/GOLD, 8 para BTC). Los errores siempre devuelven
    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (producción, dinero real)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, dinero simulado — keys pk_test_)
security:
  - bearerAuth: []
tags:
  - name: Comprobantes
    description: >-
      Comprobante PDF brandeado por operacion, con verificacion publica de
      autenticidad (QR firmado), receipt_url en cada respuesta/webhook y envio
      automatico por email en estados finales.
  - name: Autenticación
    description: >-
      Registra e inicia sesión de los miembros de la cuenta. Las sesiones duran
      24 horas.
  - name: Cuenta
    description: Perfil, miembros y llaves de API de la cuenta que llama.
  - name: Saldos
    description: Saldos, historial de movimientos y tasas de cambio.
  - name: Payouts
    description: >-
      Dispersiones fiat que se debitan del saldo de settlement que elijas (USDT
      por defecto).
  - name: Payins
    description: >-
      Recargas fiat (QR, transferencias, cuentas dedicadas, cobros pull,
      tarjetas, links de checkout) que se acreditan automáticamente — en USDT
      por defecto, o convertidas al settlement asset que elijas.
  - name: Checkout
    description: >-
      Links de checkout universal (`POST /v1/payins` con `method: "checkout"`) y
      los endpoints públicos de la página de pago — fiat multi-país, crypto con
      wallet efímera por link y pago directo CBPay, liquidado en el asset que
      elijas.
  - name: Tarjetas guardadas
    description: >-
      Tarjetas guardadas con el consentimiento explícito del pagador durante un
      pago 3-D Secure (COF). Listarlas, revocarlas y cobrarlas bajo demanda
      (MIT) sin pedir la tarjeta de nuevo.
  - name: Suscripciones
    description: >-
      Cobros recurrentes sobre una tarjeta guardada gestionados por el scheduler
      de la plataforma — diarios, semanales, mensuales o anuales, con
      pausa/reanudación/cancelación y dunning automático.
  - name: Transferencias
    description: >-
      Transferencias internas gratuitas entre cuentas CBPay (persona o empresa,
      cualquier combinación).
  - name: Contacts
    description: >-
      Libreta de beneficiarios por cuenta (destinos CBPay, bancarios y crypto)
      con match por teléfono y auto-guardado en cada envío.
  - name: Swaps
    description: >-
      Conversión instantánea entre los saldos USDT, USDC, BTC y GOLD de la
      cuenta a la tasa cotizada de la cuenta.
  - name: Crypto
    description: Fondeo y retiros on-chain (TRON, Ethereum y Bitcoin).
  - name: Wallets segregadas
    description: >-
      Wallets on-chain con saldo propio (empresas ilimitadas; personas 1 por
      combinación red+activo) — crear, importar, enviar, exportar la llave
      privada y auto-forward. El saldo vive on-chain, nunca en el ledger.
  - name: Pruebas de firma
    description: >-
      Firma criptográfica de mensajes con wallets (EIP-191 ETH/EVM, TIP-191
      TRON) — crear, listar, consultar y revocar pruebas de firma con
      verificación pública.
  - name: Vínculos de wallets
    description: >-
      Vincula wallets externas (custody=client) a tu cuenta firmando un desafío
      nonce — crear desafíos, verificar firmas, listar y revocar vínculos.
  - name: QR Crypto POS
    description: >-
      Cobros QR crypto con monto para procesadores con POS físicos (cuentas
      empresa): merchants verificados, dirección exclusiva + QR por cobro,
      detección temprana del pago, conciliación por merchant y devoluciones por
      el riel de retiro crypto.
  - name: KYC / KYB
    description: >-
      Verificación de identidad: KYC para personas, KYB para empresas — tu
      propio onboarding y verificaciones de terceros para cuentas empresa.
  - name: Screening de wallets
    description: >-
      Evaluación de riesgo AML de direcciones blockchain (sanciones, exposición
      a fondos ilícitos) con comisión por scan, más protección automática
      gratuita en retiros y depósitos.
  - name: AML screening
    description: >-
      Screening AML standalone de personas y empresas contra listas de
      sanciones, PEP y medios adversos, con re-screening, monitoreo continuo e
      informe PDF descargable.
  - name: Qscore
    description: >-
      Buró de crédito API-first. Emite informes crediticios completos con score
      1-999 (bandas A-E, o SC cuando no hay datos), consulta el último score de
      un sujeto y gestiona disputas ARCO. Chile primero, con diseño agnóstico al
      país. Cada informe emitido lleva un código de verificación pública.
  - name: Analytics
  - name: Webhooks
    description: Suscripciones para recibir notificaciones de eventos firmadas.
  - name: Estado
    description: Disponibilidad del servicio.
  - name: Banking
    description: >-
      Cuentas bancarias reales: recibe, mantén y envía dinero por rieles
      bancarios internacionales.
  - name: Cards
    description: >-
      Tarjetas virtuales y físicas que gastan Just-In-Time del saldo que elijas
      (USDT, USDC, BTC o GOLD), con límites de gasto por tarjeta.
  - name: Seguridad (OTP)
    description: >-
      Códigos de verificación de un solo uso por SMS/WhatsApp/email que protegen
      acciones sensibles, más las preferencias de 2FA self-service. Aplican solo
      a sesiones de usuario — las API keys quedan exentas.
  - name: Passkeys
    description: >-
      Inicio de sesión sin contraseña con la biometría del dispositivo (Face ID,
      Touch ID, Windows Hello, llaves de seguridad) vía WebAuthn, apps
      autenticadoras (TOTP) con códigos de respaldo, y gestión de
      sesiones/dispositivos.
  - name: Login social
    description: >-
      Registro e inicio de sesión sin contraseña con Google, Apple, Microsoft y
      Facebook vía token exchange. El front obtiene la credencial del proveedor;
      la API la verifica y emite la sesión CBPay.
  - name: Eventos en tiempo real
    description: >-
      Stream Server-Sent Events con todo lo que pasa en la cuenta (o en toda la
      organización para administradores), replay con `Last-Event-ID`, snapshot
      inicial opcional e historial consultable de 90 días.
paths:
  /v1/events:
    get:
      tags:
        - Eventos en tiempo real
      summary: Stream de eventos en tiempo real (SSE)
      description: >-
        Abre una conexión `text/event-stream` que entrega en tiempo real todos
        los eventos de la cuenta — los mismos que viajan por webhook, sin que
        expongas un endpoint público.


        Cada evento lleva `id:` (cursor monótono), `event:` (el tipo de evento)
        y `data:` (JSON con el mismo `event_id` del webhook, así ambos canales
        se cruzan).


        Reconecta con el header `Last-Event-ID` (o `?last_event_id=`) y el
        servidor replaya lo que te perdiste antes de seguir en vivo. El
        `EventSource` nativo no puede mandar el header `Authorization`: usa
        `fetch` con `ReadableStream`.


        El alcance sale de la credencial: una credencial de cuenta recibe sus
        propios eventos; una credencial org-admin con `ops:read` recibe el canal
        de toda la organización y puede acotarlo con `?account_id=`.


        La conexión manda `: ping` cada 20s, revalida la sesión cada 60s (una
        sesión revocada cierra el stream con el evento de control
        `unauthorized`) y se cierra a los 30 minutos con un evento de control
        `reconnect`.
      operationId: streamEvents
      parameters:
        - name: Last-Event-ID
          in: header
          required: false
          description: >-
            Cursor de reconexión. Alternativa al header `Last-Event-ID` para
            clientes con `fetch`.
          schema:
            type: string
          example: '4821'
        - name: last_event_id
          in: query
          required: false
          description: >-
            Cursor de reconexión. Alternativa al header `Last-Event-ID` para
            clientes con `fetch`.
          schema:
            type: string
        - name: types
          in: query
          required: false
          description: >-
            Tipos de evento separados por coma para filtrar. Un tipo desconocido
            responde `400 invalid_event_type`.
          schema:
            type: string
          example: payin_credited,payout_status_changed
        - name: snapshot
          in: query
          required: false
          description: >-
            Con `true`, el primer evento es `snapshot` con el estado actual
            absoluto (saldos y, para org-admins, salud operativa) antes de los
            deltas en vivo.
          schema:
            type: boolean
        - name: account_id
          in: query
          required: false
          description: 'Solo org-admin: acota el canal de la organización a una sola cuenta.'
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Stream de eventos abierto. El cuerpo queda abierto y se escribe
            incrementalmente.
          content:
            text/event-stream:
              schema:
                type: string
              example: >
                : cbpay event stream


                retry: 3000


                id: 4822

                event: payin_credited

                data:
                {"event_id":"7c1f0b2a-5c3d-4e6f-9a1b-2c3d4e5f6a7b","type":"payin_credited","account_id":"c57f05b6-8f2e-4d51-9a0c-5b7e2d3f4a10","created_at":"2026-07-25T18:04:11Z","cursor":"4822","data":{"payin_id":"9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d","usdt_credited":"99.700000"}}


                : ping
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          description: >-
            Demasiados streams simultáneos (`too_many_streams`) o demasiadas
            aperturas de stream desde esta IP (`rate_limited`, 600 por hora — la
            cuota cuenta intentos, no conexiones vivas).
          content:
            application/json:
              examples:
                too_many_streams:
                  summary: Límite de streams simultáneos alcanzado
                  value:
                    error: too_many_streams
                    message: >-
                      too many concurrent event streams for this account; close
                      one before opening another
                rate_limited:
                  summary: Demasiadas aperturas de stream desde esta IP
                  value:
                    error: rate_limited
                    message: too many requests
components:
  responses:
    BadRequest:
      description: >-
        Solicitud inválida (ver el código `error` para la validación
        específica).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_json
            message: 'request body is not valid JSON: unknown field'
    Unauthorized:
      description: Credencial faltante o inválida (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Código de error legible por máquina (snake_case).
          example: insufficient_funds
        message:
          type: string
          description: Explicación legible por humanos.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        JWT de sesión (de register/login) o llave de API (`pk_...`).
        `X-API-Key: <token>` se acepta como header alternativo.

````