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

# 创建 swap

> 在你的两种货币之间同步、原子地兑换余额——余额即时变动,资金从不离开你的账户(无需 OTP)。波动性交易对(BTC/GOLD)与 payouts 和卡片消费共享单笔及 24 小时交易量限额。必须提供幂等键:重放会返回原始 swap,绝不重复执行。



## OpenAPI

````yaml /openapi.zh.yaml post /v1/swaps
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/swaps:
    post:
      tags:
        - 兑换(Swaps)
      summary: 创建 swap
      description: >-
        在你的两种货币之间同步、原子地兑换余额——余额即时变动,资金从不离开你的账户(无需 OTP)。波动性交易对(BTC/GOLD)与 payouts
        和卡片消费共享单笔及 24 小时交易量限额。必须提供幂等键:重放会返回原始 swap,绝不重复执行。
      operationId: createSwap
      parameters:
        - $ref: '#/components/parameters/idempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - from_asset
                - to_asset
                - amount
              properties:
                from_asset:
                  type: string
                  enum:
                    - USDT
                    - USDC
                    - BTC
                    - GOLD
                to_asset:
                  type: string
                  enum:
                    - USDT
                    - USDC
                    - BTC
                    - GOLD
                amount:
                  type: string
                  description: 源货币金额(USDT/USDC/GOLD 为 6 位小数,BTC 为 8 位)。
                idempotency_key:
                  type: string
            examples:
              usdt_btc:
                summary: USDT 兑换 BTC
                value:
                  from_asset: USDT
                  to_asset: BTC
                  amount: '1000'
                  idempotency_key: swap-2026-07-10-a
              cross:
                summary: BTC 直接兑换 GOLD
                value:
                  from_asset: BTC
                  to_asset: GOLD
                  amount: '0.01'
                  idempotency_key: swap-2026-07-10-b
              stables:
                summary: USDT 兑换 USDC
                value:
                  from_asset: USDT
                  to_asset: USDC
                  amount: '500'
                  idempotency_key: swap-2026-07-10-c
      responses:
        '200':
          description: 幂等重放(原始 swap,绝不重复执行)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Swap'
              example:
                swap_id: 8a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                from_asset: USDT
                to_asset: BTC
                from_amount: '1000.000000'
                to_amount: '0.01568419'
                rate: '0.00001568'
                status: completed
                idempotency_key: swap-2026-07-10-a
                created_at: '2026-07-10T15:00:00Z'
                idempotency_hit: true
        '201':
          description: swap 已执行(同步)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Swap'
              example:
                swap_id: 8a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                from_asset: USDT
                to_asset: BTC
                from_amount: '1000.000000'
                to_amount: '0.01568419'
                rate: '0.00001568'
                status: completed
                idempotency_key: swap-2026-07-10-a
                created_at: '2026-07-10T15:00:00Z'
        '400':
          description: >-
            invalid_asset / invalid_pair / invalid_amount / amount_too_small /
            swap_asset_disabled / idempotency_key_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: amount_too_small
                message: amount is too small to convert at the current rate
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientFunds'
        '403':
          description: verification_required / service_disabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: service_disabled
                message: this service is not enabled for your account
        '422':
          description: >-
            settlement_limit_exceeded / settlement_daily_limit_exceeded(与
            payouts 和卡片共享的波动性上限)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: settlement_daily_limit_exceeded
                message: >-
                  the account exceeded its 24h volume for volatile assets; retry
                  later or use smaller amounts
        '503':
          description: 执行价格不可用或过期(pricing_unavailable)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: pricing_unavailable
                message: execution price is unavailable or stale; retry later
components:
  parameters:
    idempotencyKeyHeader:
      name: Idempotency-Key
      in: header
      required: false
      description: '`idempotency_key` 请求体字段的替代方式。'
      schema:
        type: string
  schemas:
    Swap:
      type: object
      properties:
        swap_id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
          description: 所属账户。使组织管理员能在全组织视图中归属每条记录。
        from_asset:
          type: string
          enum:
            - USDT
            - USDC
            - BTC
            - GOLD
        to_asset:
          type: string
          enum:
            - USDT
            - USDC
            - BTC
            - GOLD
        from_amount:
          type: string
        to_amount:
          type: string
        rate:
          type: string
          description: 每单位源资产可得的目标资产单位数(标记后的执行汇率)。
        status:
          type: string
          example: completed
        idempotency_key:
          type: string
        created_at:
          type: string
          format: date-time
        idempotency_hit:
          type: boolean
          description: 重放时出现。
    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
    InsufficientFunds:
      description: 账户余额不足以完成此操作(`insufficient_funds`)。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: insufficient_funds
            message: account balance is not enough for this operation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        会话 JWT(来自注册/登录)或 API key(`pk_...`)。
        也接受 `X-API-Key: <token>` 作为替代请求头。

````