> ## 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、加密提现)自动创建,也可手动增删改或导入手机通讯录。



## OpenAPI

````yaml /openapi.zh.yaml get /v1/contacts
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/contacts:
    get:
      tags:
        - 联系人
      summary: 列出联系人
      description: 你账户的私人联系人簿,按收藏与最近使用排序。联系人由每次发送(转账、payout、加密提现)自动创建,也可手动增删改或导入手机通讯录。
      operationId: listContacts
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: q
          in: query
          schema:
            type: string
          description: 按姓名、别名、邮箱或电话搜索。
        - name: has_cbpay
          in: query
          schema:
            type: boolean
          description: 仅限已关联(或未关联)CBPay 账户的联系人。
        - name: favorite
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: 联系人分页。
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                  page_size:
                    type: integer
                  contacts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
              example:
                page: 1
                page_size: 50
                contacts:
                  - contact_id: 3f8a1b2c-4d5e-6f70-8a9b-0c1d2e3f4a5b
                    display_name: Carlos Soto
                    alias: Carlitos
                    phone: '+56987654321'
                    email: carlos@mail.com
                    has_cbpay: true
                    cbpay_account_id: 389d34a3-6c61-4782-b822-95ac173068dc
                    source: import
                    favorite: true
                    created_at: '2026-07-07T12:00:00Z'
                    updated_at: '2026-07-10T15:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountRequired'
components:
  parameters:
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
    pageSize:
      name: page_size
      in: query
      schema:
        type: integer
        default: 50
        maximum: 200
  schemas:
    Contact:
      type: object
      properties:
        contact_id:
          type: string
          format: uuid
        display_name:
          type: string
        alias:
          type: string
        phone:
          type: string
          description: E.164。
        email:
          type: string
        has_cbpay:
          type: boolean
          description: 当手机号匹配你运营方的活跃账户时为 true。
        cbpay_account_id:
          type: string
          format: uuid
          description: 已关联的账户(has_cbpay 为 true 时出现)。
        source:
          type: string
          enum:
            - manual
            - import
            - transfer
            - payout
            - crypto
        favorite:
          type: boolean
        destinations:
          type: array
          description: 详情端点中出现。
          items:
            $ref: '#/components/schemas/ContactDestination'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ContactDestination:
      type: object
      properties:
        destination_id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - cbpay
            - payout
            - crypto
        country:
          type: string
        currency:
          type: string
        method:
          type: string
        chain:
          type: string
        address:
          type: string
        details:
          type: object
          description: payout 目的地的完整受益人信息。
        label:
          type: string
        last_used_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
    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>` 作为替代请求头。

````