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

# 用于仪表盘的账户摘要

> 一次调用即可获得账户全部流水的汇总视图:总流入/流出、交易笔数、新增 banking 用户、按服务划分的分区(payouts、payins、充值、提现、transfers、swaps、cards、banking、verifications、aml、contacts)及其维度(国家、货币、方式、状态、链、商户)、服务支出与估值后的余额。金额为 USD 十进制字符串;空桶以零填充。仅限账户凭证。




## OpenAPI

````yaml /openapi.zh.yaml get /v1/analytics/summary
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/analytics/summary:
    get:
      tags:
        - 分析
      summary: 用于仪表盘的账户摘要
      description: >
        一次调用即可获得账户全部流水的汇总视图:总流入/流出、交易笔数、新增 banking
        用户、按服务划分的分区(payouts、payins、充值、提现、transfers、swaps、cards、banking、verifications、aml、contacts)及其维度(国家、货币、方式、状态、链、商户)、服务支出与估值后的余额。金额为
        USD 十进制字符串;空桶以零填充。仅限账户凭证。
      operationId: analyticsSummary
      parameters:
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: granularity
          in: query
          schema:
            type: string
            enum:
              - day
              - week
              - month
            default: day
      responses:
        '200':
          description: 账户分析摘要。
          content:
            application/json:
              example:
                account_id: ae8cf540-22a9-414d-82cc-8ac04732be4f
                from: '2026-07-01'
                to: '2026-07-10'
                granularity: day
                timezone: UTC
                gross_volume:
                  in: '636936.87'
                  out: '270118.87'
                  total: '907055.74'
                  series:
                    - date: '2026-07-01'
                      in: '51023.10'
                      out: '31210.44'
                      total: '82233.54'
                  previous_period:
                    in: '512300.00'
                    out: '241000.10'
                    total: '753300.10'
                  change_pct: '20.41'
                  unpriced_assets: []
                transactions:
                  total: 92
                  series:
                    - date: '2026-07-01'
                      in: 3
                      out: 5
                      total: 8
                  previous_period:
                    total: 71
                  change_pct: '29.58'
                new_users:
                  total: 11
                  series:
                    - date: '2026-07-01'
                      count: 1
                  previous_period:
                    total: 6
                  change_pct: '83.33'
                by_country:
                  - country: BR
                    payouts:
                      count: 18
                      volume_usd: '3410.20'
                    payins:
                      count: 4
                      volume_usd: '820.00'
                    total_usd: '4230.20'
                sections:
                  payouts:
                    count: 24
                    volume_usd: '5120.40'
                    fees_usd: '7.20'
                    by_status:
                      - key: completed
                        count: 21
                        volume_usd: '4980.10'
                    by_country:
                      - country: BR
                        count: 18
                        volume_usd: '3410.20'
                        local_volume:
                          BRL: '17550'
                    by_method:
                      - key: pix
                        count: 18
                        volume_usd: '3410.20'
                  cards:
                    count: 12
                    volume_usd: '230.50'
                    active_cards: 1
                    by_status:
                      - status: settled
                        count: 10
                        volume_usd: '205.00'
                    top_merchants:
                      - merchant: AMAZON
                        count: 4
                        volume_usd: '98.20'
                  banking:
                    new_third_parties: 11
                    new_accounts: 14
                    operations: 6
                    volume:
                      in:
                        count: 4
                        volume_usd: '1200.00'
                      out:
                        count: 9
                        volume_usd: '3450.00'
                      volume_usd: '4650.00'
                    fees_usd: '18.00'
                  verifications:
                    submissions:
                      - kind: kyc
                        status: approved
                        count: 3
                    fees_usd: '9.00'
                    fees_by_kind:
                      kyc_verification:
                        count: 3
                        fees_usd: '6.00'
                      kyb_verification:
                        count: 1
                        fees_usd: '3.00'
                  adjustments:
                    count: 2
                    volume_usd: '2000.00'
                spending:
                  total_usd: '34.50'
                  by_service:
                    banking_customer:
                      count: 11
                      fees_usd: '11.00'
                balances:
                  items:
                    - asset: USDT
                      available: '1520.250000'
                      held: '0.000000'
                      usd_estimate: '1520.25'
                  net_worth_usd_estimate: '1833.93'
        '400':
          description: invalid_range / invalid_granularity
        '403':
          description: account_required
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        会话 JWT(来自注册/登录)或 API key(`pk_...`)。
        也接受 `X-API-Key: <token>` 作为替代请求头。

````