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

# 停用或重新启用 webhook 订阅

> 将账户的某个订阅在 `active` 和 `disabled` 之间切换。`disabled` 状态的订阅停止接收新事件；已排队的投递仍会发出。幂等：重复当前状态返回 `200` 且无变化。订阅永远不会被删除——停用即退订。强制执行归属权：其他账户的 订阅返回 `404`（与不存在的订阅无法区分）。




## OpenAPI

````yaml /openapi.zh.yaml patch /v1/webhooks/subscriptions/{subscriptionID}
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/webhooks/subscriptions/{subscriptionID}:
    patch:
      tags:
        - Webhooks
      summary: 停用或重新启用 webhook 订阅
      description: >
        将账户的某个订阅在 `active` 和 `disabled` 之间切换。`disabled`
        状态的订阅停止接收新事件；已排队的投递仍会发出。幂等：重复当前状态返回 `200`
        且无变化。订阅永远不会被删除——停用即退订。强制执行归属权：其他账户的 订阅返回 `404`（与不存在的订阅无法区分）。
      operationId: updateWebhookSubscriptionStatus
      parameters:
        - name: subscriptionID
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - status
              properties:
                status:
                  type: string
                  enum:
                    - active
                    - disabled
            examples:
              disable:
                summary: 停用订阅
                value:
                  status: disabled
              reactivate:
                summary: 重新启用订阅
                value:
                  status: active
      responses:
        '200':
          description: 返回订阅及其当前状态。
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  event_type:
                    type: string
                  callback_url:
                    type: string
                  status:
                    type: string
                    enum:
                      - active
                      - disabled
                  created_at:
                    type: string
                    format: date-time
              examples:
                disabled:
                  summary: 订阅已停用
                  value:
                    id: 8e7f6a5b-4c3d-2e1f-0a9b-8c7d6e5f4a3b
                    event_type: payout_status_changed
                    callback_url: https://api.myapp.com/webhooks/cbpay
                    status: disabled
                    created_at: '2026-07-07T12:00:00Z'
        '400':
          description: '`invalid_status`：状态必须为 `active` 或 `disabled`。'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidStatus:
                  summary: 状态超出目录范围
                  value:
                    error: invalid_status
                    message: status must be active or disabled
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 机器可读的错误代码(snake_case)。
          example: insufficient_funds
        message:
          type: string
          description: 人类可读的说明。
  responses:
    Unauthorized:
      description: 凭证缺失或无效(`unauthorized`)。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
    NotFound:
      description: 资源未找到(`not_found`)。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not_found
            message: resource not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        会话 JWT(来自注册/登录)或 API key(`pk_...`)。
        也接受 `X-API-Key: <token>` 作为替代请求头。

````