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

# 主动收款(pull)

> 在支持 pull 收款的通道(例如委内瑞拉 `c2p` / `debito_inmediato`)直接向付款人扣款。同步执行:若扣款获批,存款按你当前的 `payin_rate` 转换并在同一调用中入账,已扣除 payin 费用。若付款人拒绝,`paid` 为 false,payin 标记为 failed 且不产生任何扣款。



## OpenAPI

````yaml /openapi.zh.yaml post /v1/payins/collect
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/payins/collect:
    post:
      tags:
        - 收款(Payins)
      summary: 主动收款(pull)
      description: >-
        在支持 pull 收款的通道(例如委内瑞拉 `c2p` /
        `debito_inmediato`)直接向付款人扣款。同步执行:若扣款获批,存款按你当前的 `payin_rate`
        转换并在同一调用中入账,已扣除 payin 费用。若付款人拒绝,`paid` 为 false,payin 标记为 failed
        且不产生任何扣款。
      operationId: payinCollect
      parameters:
        - $ref: '#/components/parameters/idempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - method
                - amount
                - idempotency_key
              properties:
                country:
                  type: string
                  default: VE
                currency:
                  type: string
                  default: VES
                method:
                  type: string
                  description: 收款方式(例如 c2p、debito_inmediato)。
                amount:
                  type: string
                  description: 本地金额,正数十进制字符串。
                description:
                  type: string
                our_reference:
                  type: string
                payer_document:
                  type: string
                payer_phone:
                  type: string
                payer_bank:
                  type: string
                payer_account:
                  type: string
                payer_name:
                  type: string
                payer_account_type:
                  type: string
                otp:
                  type: string
                otp_reference:
                  type: string
                idempotency_key:
                  type: string
                  description: 必填——collect 执行真实扣款;使用相同键的重试绝不重复扣款。
            example:
              method: c2p
              amount: '1200.00'
              description: 订单 5512
              payer_document: V12345678
              payer_phone: '04141234567'
              payer_bank: '0102'
              otp: '12345678'
              idempotency_key: collect-2026-07-07-a
      responses:
        '200':
          description: '收款结果。`paid: true` 表示存款已入账。'
          content:
            application/json:
              schema:
                type: object
                properties:
                  payin_id:
                    type: string
                  kind:
                    type: string
                  country:
                    type: string
                  currency:
                    type: string
                  method:
                    type: string
                  local_amount:
                    type: string
                  status:
                    type: string
                  fx_rate:
                    type: string
                  usdt_gross:
                    type: string
                  fee:
                    type: string
                  usdt_credited:
                    type: string
                  paid:
                    type: boolean
                  provider_reference:
                    type: string
                  status_code:
                    type: string
                  status_message:
                    type: string
                  failure:
                    type: object
                    description: >-
                      仅当主动收款的 payin 为 `failed` 时出现：拒绝来源（`provider` =
                      付款人的银行，`core` = 扣款前校验）以及具体的代码和消息。
                    properties:
                      source:
                        type: string
                      code:
                        type: string
                      message:
                        type: string
              example:
                payin_id: 7b3c9e2f-1a2b-3c4d-5e6f-7a8b9c0d1e2f
                account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                kind: collect
                country: VE
                currency: VES
                method: c2p
                local_amount: '1200.00'
                status: credited
                reference: REF-102030
                fx_rate: '36.50'
                usdt_gross: '32.876712'
                fee: '0.300000'
                usdt_credited: '32.576712'
                paid: true
                provider_reference: PRV-889911
                status_code: '00'
                status_message: approved
                created_at: '2026-07-07T12:00:00Z'
                updated_at: '2026-07-07T12:00:02Z'
        '400':
          description: invalid_request / invalid_amount
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_request
                message: method is required (e.g. c2p, debito_inmediato)
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: 账户未激活(account_blocked)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: account_blocked
                message: account is not active
        '502':
          description: 核心不可用(core_unavailable)。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: core_unavailable
                message: could not execute the collection
components:
  parameters:
    idempotencyKeyHeader:
      name: Idempotency-Key
      in: header
      required: false
      description: '`idempotency_key` 请求体字段的替代方式。'
      schema:
        type: string
  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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        会话 JWT(来自注册/登录)或 API key(`pk_...`)。
        也接受 `X-API-Key: <token>` 作为替代请求头。

````