> ## 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.

# 实时事件流（SSE）

> 打开 `text/event-stream` 连接，实时推送账户的全部事件——与 webhook 推送的是同一批事件，但你无需对外暴露任何公开端点。

每条事件包含 `id:`（单调游标）、`event:`（事件类型）和 `data:`（JSON，其 `event_id` 与 webhook 完全一致，便于两个通道相互对照）。

使用 `Last-Event-ID` 请求头（或 `?last_event_id=`）重连，服务端会先重放你错过的事件，再继续实时推送。浏览器原生 `EventSource` 无法发送 `Authorization` 请求头：请使用 `fetch` 配合 `ReadableStream`。

可见范围由凭证决定：账户凭证只接收自己的事件；具备 `ops:read` 的组织管理员凭证接收全组织通道，并可用 `?account_id=` 缩小范围。

连接每 20 秒发送 `: ping`，每 60 秒重新校验会话（会话被吊销时以 `unauthorized` 控制事件关闭流），并在 30 分钟后以 `reconnect` 控制事件关闭。



## OpenAPI

````yaml /openapi.zh.yaml get /v1/events
openapi: 3.1.0
info:
  title: CBPay API
  version: '2.62'
  description: >
    CBPay 是一个多币种支付平台:覆盖拉美的法币付款(payout)与收款(payin)、内部转账、链上充值与提现,以及 KYC
    筛查。每个账户持有四个相互独立的虚拟余额——USDT(运营货币)、USDC、BTC 和 GOLD(纯金克数)——可通过兑换(swap)按需转换。

    payout 和服务费可从四个余额中的任意一个支付(用 `PUT /v1/settlement`

    设置默认值,或在单笔 payout 中用 `settlement_asset` 覆盖);payin

    可自动兑换为你选择的资产(`default_payin_asset`)。


    所有金额均为十进制字符串,遵循各货币的精度(USDT/USDC/GOLD 为 6 位小数,BTC 为 8 位)。错误始终返回

    `{"error": "<code>", "message": "<detail>"}`。
servers:
  - url: https://api.qbank.cl/platform
    description: Live（生产环境，真实资金）
  - url: https://cryptobank.qbank.cl/platform
    description: Test（沙盒，模拟资金 — pk_test_ 密钥）
security:
  - bearerAuth: []
tags:
  - name: 凭证
    description: >-
      每笔操作的品牌化 PDF 凭证,附带公开的签名 QR 真伪校验、每个响应/webhook 中的
      receipt_url,以及最终状态时的自动邮件发送。
  - name: 身份认证
    description: 注册与登录账户成员。会话有效期 24 小时。
  - name: 账户
    description: 调用账户的档案、成员与 API key。
  - name: 余额
    description: 余额、流水历史与外汇汇率。
  - name: 付款(Payouts)
    description: 从你选择的结算余额扣款的法币派发(默认 USDT)。
  - name: 收款(Payins)
    description: 法币充值(二维码、转账、专属账户、pull 收款、卡片、checkout 链接)自动入账——默认入账 USDT,也可自动兑换为你选择的结算资产。
  - name: 收银台(Checkout)
    description: >-
      通用收银台链接(`POST /v1/payins`,`method:
      "checkout"`)与公开支付页端点——多国法币、每个链接专属临时钱包的加密货币支付,以及 CBPay 直接支付,按你选择的资产结算。
  - name: 已保存卡片(Stored cards)
    description: 在 3-D Secure 支付中经付款人明确同意保存的卡片(COF)。可列出、吊销并按需扣款(MIT),无需再次索要卡片信息。
  - name: 订阅(Subscriptions)
    description: 由平台调度器管理的已保存卡片周期性扣款——按日、周、月或年,支持暂停/恢复/取消与自动催收。
  - name: 转账
    description: CBPay 账户之间的免费内部转账(个人或企业,任意组合)。
  - name: 联系人
    description: 按账户维护的收款人通讯录(CBPay、银行与加密货币目的地),支持手机号匹配与每次发送时自动保存。
  - name: 兑换(Swaps)
    description: 按账户报价即时兑换账户的 USDT、USDC、BTC 与 GOLD 余额。
  - name: 加密货币
    description: 链上充值与提现(TRON、Ethereum 和 Bitcoin)。
  - name: 隔离钱包
    description: 拥有自身余额的链上钱包(企业不限数量;个人每个网络+资产组合 1 个)——创建、导入、发送、导出私钥与自动转发。余额存在于链上,从不进入账本。
  - name: 签名证明
    description: 使用钱包进行加密消息签名(EIP-191 ETH/EVM、TIP-191 TRON)——创建、列出、查询和吊销具有公开验证功能的签名证明。
  - name: 钱包链接
    description: 通过签名 nonce 挑战将外部钱包(custody=client)链接到你的账户——创建挑战、验证签名、列出和吊销链接。
  - name: QR Crypto POS
    description: >-
      面向拥有实体 POS 终端的处理商（企业账户）的定额加密货币二维码收款：已验证商户、每笔收款专属地址 +
      二维码、支付早期检测、按商户对账，以及经加密货币提现通道的退款。
  - name: KYC / KYB
    description: 身份验证:个人 KYC、企业 KYB——你自己的入驻验证,以及企业账户的第三方验证。
  - name: AML 筛查
    description: 针对个人与企业的独立 AML 筛查(制裁、PEP 与负面媒体名单),含重新筛查、持续监控与可下载的 PDF 报告。
  - name: 钱包筛查
    description: 区块链地址的 AML 风险评估(制裁、非法资金暴露),按次收费;另附提现与充值的免费自动防护。
  - name: Qscore
    description: >-
      API 优先的信用局。签发完整的信用报告，评分为 1-999（A-E 等级，无数据时为 SC），查询主体的最新评分，并管理 ARCO
      争议。智利先行，设计上与国家无关。每份签发的报告都带有公开验证码。
  - name: 分析
  - name: Webhooks
    description: 接收签名事件通知的订阅。
  - name: 状态
    description: 服务可用性。
  - name: 银行服务
    description: 真实银行账户:通过国际银行通道接收、持有与发送资金。
  - name: 卡片
    description: 以 Just-In-Time 方式从你选择的余额(USDT、USDC、BTC 或 GOLD)消费的虚拟卡与实体卡,支持按卡设置消费限额。
  - name: 安全(OTP)
    description: >-
      通过 SMS/WhatsApp/email 发送的一次性验证码,保护敏感操作;并提供自助 2FA 偏好设置。仅适用于用户会话——API key
      豁免。
  - name: 通行密钥
    description: >-
      通过 WebAuthn 使用设备生物识别(Face ID、Touch ID、Windows
      Hello、安全密钥)的无密码登录、带备份码的验证器应用(TOTP),以及会话/设备管理。
  - name: 社交登录
    description: >-
      通过令牌交换以 Google、Apple、Microsoft 和 Facebook 实现无密码注册与登录。前端获取提供方凭证;API 验证后签发
      CBPay 会话。
  - name: 实时事件
    description: >-
      Server-Sent Events 流，实时推送账户内（管理员则为整个组织）发生的所有事件，支持通过 `Last-Event-ID`
      重放、可选的初始快照，以及 90 天可查询历史。
paths:
  /v1/events:
    get:
      tags:
        - 实时事件
      summary: 实时事件流（SSE）
      description: >-
        打开 `text/event-stream` 连接，实时推送账户的全部事件——与 webhook
        推送的是同一批事件，但你无需对外暴露任何公开端点。


        每条事件包含 `id:`（单调游标）、`event:`（事件类型）和 `data:`（JSON，其 `event_id` 与 webhook
        完全一致，便于两个通道相互对照）。


        使用 `Last-Event-ID` 请求头（或
        `?last_event_id=`）重连，服务端会先重放你错过的事件，再继续实时推送。浏览器原生 `EventSource` 无法发送
        `Authorization` 请求头：请使用 `fetch` 配合 `ReadableStream`。


        可见范围由凭证决定：账户凭证只接收自己的事件；具备 `ops:read` 的组织管理员凭证接收全组织通道，并可用 `?account_id=`
        缩小范围。


        连接每 20 秒发送 `: ping`，每 60 秒重新校验会话（会话被吊销时以 `unauthorized` 控制事件关闭流），并在 30
        分钟后以 `reconnect` 控制事件关闭。
      operationId: streamEvents
      parameters:
        - name: Last-Event-ID
          in: header
          required: false
          description: 重连游标。面向 `fetch` 客户端，是 `Last-Event-ID` 请求头的替代方案。
          schema:
            type: string
          example: '4821'
        - name: last_event_id
          in: query
          required: false
          description: 重连游标。面向 `fetch` 客户端，是 `Last-Event-ID` 请求头的替代方案。
          schema:
            type: string
        - name: types
          in: query
          required: false
          description: 以逗号分隔的事件类型过滤条件。未知类型返回 `400 invalid_event_type`。
          schema:
            type: string
          example: payin_credited,payout_status_changed
        - name: snapshot
          in: query
          required: false
          description: >-
            设为 `true` 时，第一条事件为
            `snapshot`，包含当前的绝对状态（余额；组织管理员还包含运营健康度），随后才是实时增量事件。
          schema:
            type: boolean
        - name: account_id
          in: query
          required: false
          description: 仅组织管理员可用：将全组织通道缩小到单个账户。
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: 事件流已打开。响应体保持打开状态并持续增量写入。
          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: >-
            并发事件流过多（`too_many_streams`），或该 IP 开流过于频繁（`rate_limited`，每小时 600
            次——该配额统计尝试次数，而非活动连接）。
          content:
            application/json:
              examples:
                too_many_streams:
                  summary: 已达到并发事件流上限
                  value:
                    error: too_many_streams
                    message: >-
                      too many concurrent event streams for this account; close
                      one before opening another
                rate_limited:
                  summary: 该 IP 开流过于频繁
                  value:
                    error: rate_limited
                    message: too many requests
components:
  responses:
    BadRequest:
      description: 请求无效(具体校验见 `error` 代码)。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_json
            message: 'request body is not valid JSON: unknown field'
    Unauthorized:
      description: 凭证缺失或无效(`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: 机器可读的错误代码(snake_case)。
          example: insufficient_funds
        message:
          type: string
          description: 人类可读的说明。
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        会话 JWT(来自注册/登录)或 API key(`pk_...`)。
        也接受 `X-API-Key: <token>` 作为替代请求头。

````