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

# 扫描 payout QR(玻利维亚、巴西)

> QR payout 第 1 步——玻利维亚(本地互通 QR)与巴西(PIX QR,含 "copia e cola" 代码):读取收款 QR 并返回收款人数据及确认所需的 `provider_reference`。**免费**——确认步骤之前不会有任何扣款。默认玻利维亚;巴西请传 `country: "BR"` 和 `currency: "BRL"`。巴西支持**静态** PIX 二维码(内嵌收款密钥);动态二维码(载荷为 PSP URL)返回 `400`——请向收款人索取其 PIX 密钥并改用 `pix` 方式。扫码响应中 `amount` 为空表示该二维码为开放金额。



## OpenAPI

````yaml /openapi.zh.yaml post /v1/payouts/qr/scan
openapi: 3.1.0
info:
  title: CBPay API
  version: '1.89'
  description: >
    CBPay 是一个多币种支付平台:覆盖拉美的法币付款(payout)与收款(payin)、内部转账、链上充值与提现,以及 KYC
    筛查。每个账户持有四个相互独立的虚拟余额——USDT(运营货币)、USDC、BTC 和 GOLD(纯金克数)——它们绝不混合也不会自动兑换。

    payout 和服务费可从四个余额中的任意一个支付:

    用 `PUT /v1/settlement` 设置默认值,或在单笔 payout 中用

    `settlement_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: 入账到 USDT 余额的法币充值。
  - name: 转账
  - name: 联系人
  - name: 兑换(Swaps)
    description: CBPay 账户之间的免费内部转账(个人或企业,任意组合)。
  - name: 加密货币
    description: 链上充值与提现(TRON、Ethereum 和 Bitcoin)。
  - name: 隔离钱包
    description: 拥有自身余额的链上钱包(企业不限数量;个人每个网络+资产组合 1 个)——创建、导入、发送、导出私钥与自动转发。余额存在于链上,从不进入账本。
  - name: QR Crypto POS
    description: >-
      面向拥有实体 POS 终端的处理商（企业账户）的定额加密货币二维码收款：已验证商户、每笔收款专属地址 +
      二维码、支付早期检测、按商户对账，以及经加密货币提现通道的退款。
  - name: KYC / KYB
  - name: AML 筛查
    description: 身份验证:个人 KYC、企业 KYB,含 AML 筛查、重新筛查与持续监控。
  - name: 钱包筛查
    description: 区块链地址的 AML 风险评估(制裁、非法资金暴露),按次收费;另附提现与充值的免费自动防护。
  - name: 分析
  - name: Webhooks
    description: 接收签名事件通知的订阅。
  - name: 状态
    description: 服务可用性。
  - name: 银行服务
    description: 真实银行账户:通过国际银行通道接收、持有与发送资金。
  - name: 卡片
    description: 以 Just-In-Time 方式从账户 USDT 余额消费的虚拟卡与实体卡,支持按卡设置消费限额。
  - 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 会话。
paths:
  /v1/payouts/qr/scan:
    post:
      tags:
        - 付款(Payouts)
      summary: 扫描 payout QR(玻利维亚、巴西)
      description: >-
        QR payout 第 1 步——玻利维亚(本地互通 QR)与巴西(PIX QR,含 "copia e cola" 代码):读取收款 QR
        并返回收款人数据及确认所需的 `provider_reference`。**免费**——确认步骤之前不会有任何扣款。默认玻利维亚;巴西请传
        `country: "BR"` 和 `currency: "BRL"`。巴西支持**静态** PIX 二维码(内嵌收款密钥);动态二维码(载荷为
        PSP URL)返回 `400`——请向收款人索取其 PIX 密钥并改用 `pix` 方式。扫码响应中 `amount`
        为空表示该二维码为开放金额。
      operationId: payoutQrScan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - qr_payload
              properties:
                country:
                  type: string
                  enum:
                    - BO
                    - BR
                  default: BO
                currency:
                  type: string
                  enum:
                    - BOB
                    - USD
                    - BRL
                  default: BOB
                qr_payload:
                  type: string
                  description: 扫描 QR 的原始内容(在巴西同时是 PIX "copia e cola" 代码)。
            example:
              qr_payload: <QR content>
              currency: BOB
      responses:
        '200':
          description: 供用户确认的收款人数据。
          content:
            application/json:
              schema:
                type: object
                properties:
                  scan_id:
                    type: string
                  provider_reference:
                    type: string
                  beneficiary_name:
                    type: string
                  destination_account:
                    type: string
                  amount:
                    type: string
                  currency:
                    type: string
                  glosa:
                    type: string
                  status:
                    type: string
              example:
                scan_id: 5c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f
                provider_reference: QR-REF-889923
                beneficiary_name: Juan Quispe
                destination_account: '****4521'
                amount: '700.00'
                currency: BOB
                glosa: ''
                status: scanned
        '400':
          description: >-
            缺少 qr_payload(invalid_request),或二维码不可读/不受支持(invalid_qr_payload——BR
            Code 损坏、校验和无效或动态 PIX 二维码;message 说明具体原因)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_qr_payload
                message: >-
                  dynamic pix qr codes are not supported yet: pay with method
                  pix using the beneficiary pix key
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountRequired'
        '502':
          description: 核心不可用(core_unavailable)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: core_unavailable
                message: could not scan the QR
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
    AccountRequired:
      description: 此端点需要账户凭证(`account_required`)。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: account_required
            message: this endpoint requires an account credential
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        会话 JWT(来自注册/登录)或 API key(`pk_...`)。
        也接受 `X-API-Key: <token>` 作为替代请求头。

````