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

# Resumen de la cuenta para dashboards

> Aggregated view of the whole account flow in a single call: gross volume in/out, transaction counts, new banking users, per-service sections (payouts, payins, deposits, withdrawals, transfers, swaps, cards, banking, verifications, aml, contacts) with their dimensions (country, currency, method, status, chain, merchant), service spending and valued balances. Amounts are USD decimal strings; empty buckets are zero-filled. Account credential only.




## OpenAPI

````yaml /openapi.es.yaml get /v1/analytics/summary
openapi: 3.1.0
info:
  title: CBPay API
  version: '1.89'
  description: |
    CBPay es una plataforma de pagos multimoneda: payouts y cobros fiat
    en toda América Latina, transferencias internas, fondeo y retiros
    on-chain, y screening KYC. Cada cuenta mantiene cuatro saldos virtuales
    independientes — USDT (la moneda operativa), USDC, BTC y GOLD (gramos de
    oro fino) — que nunca se mezclan ni se convierten automáticamente.
    Los payouts y las comisiones de servicios pueden pagarse desde cualquiera
    de los cuatro saldos: define un predeterminado con `PUT /v1/settlement` o
    haz override por payout con `settlement_asset`.

    Todos los montos son strings decimales en la precisión de cada moneda (6
    decimales para USDT/USDC/GOLD, 8 para BTC). Los errores siempre devuelven
    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (producción, dinero real)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, dinero simulado — keys pk_test_)
security:
  - bearerAuth: []
tags:
  - name: Comprobantes
    description: >-
      Comprobante PDF brandeado por operacion, con verificacion publica de
      autenticidad (QR firmado), receipt_url en cada respuesta/webhook y envio
      automatico por email en estados finales.
  - name: Autenticación
    description: >-
      Registra e inicia sesión de los miembros de la cuenta. Las sesiones duran
      24 horas.
  - name: Cuenta
    description: Perfil, miembros y llaves de API de la cuenta que llama.
  - name: Saldos
    description: Saldos, historial de movimientos y tasas de cambio.
  - name: Payouts
    description: >-
      Dispersiones fiat que se debitan del saldo de settlement que elijas (USDT
      por defecto).
  - name: Payins
    description: Recargas fiat que se acreditan al saldo en USDT.
  - name: Transferencias
  - name: Contacts
  - name: Swaps
    description: >-
      Transferencias internas gratuitas entre cuentas CBPay (persona o empresa,
      cualquier combinación).
  - name: Crypto
    description: Fondeo y retiros on-chain (TRON, Ethereum y Bitcoin).
  - name: Wallets segregadas
    description: >-
      Wallets on-chain con saldo propio (empresas ilimitadas; personas 1 por
      combinación red+activo) — crear, importar, enviar, exportar la llave
      privada y auto-forward. El saldo vive on-chain, nunca en el ledger.
  - name: QR Crypto POS
    description: >-
      Cobros QR crypto con monto para procesadores con POS físicos (cuentas
      empresa): merchants verificados, dirección exclusiva + QR por cobro,
      detección temprana del pago, conciliación por merchant y devoluciones por
      el riel de retiro crypto.
  - name: KYC / KYB
  - name: Screening de wallets
    description: >-
      Evaluación de riesgo AML de direcciones blockchain (sanciones, exposición
      a fondos ilícitos) con comisión por scan, más protección automática
      gratuita en retiros y depósitos.
  - name: AML screening
    description: >-
      Verificación de identidad: KYC para personas, KYB para empresas, con
      screening AML, re-screening y monitoreo continuo.
  - name: Analytics
  - name: Webhooks
    description: Suscripciones para recibir notificaciones de eventos firmadas.
  - name: Estado
    description: Disponibilidad del servicio.
  - name: Banking
    description: >-
      Cuentas bancarias reales: recibe, mantén y envía dinero por rieles
      bancarios internacionales.
  - name: Cards
    description: >-
      Tarjetas virtuales y físicas que gastan Just-In-Time del saldo USDT de la
      cuenta, con límites de gasto por tarjeta.
  - name: Seguridad (OTP)
    description: >-
      Códigos de verificación de un solo uso por SMS/WhatsApp/email que protegen
      acciones sensibles, más las preferencias de 2FA self-service. Aplican solo
      a sesiones de usuario — las API keys quedan exentas.
  - name: Passkeys
    description: >-
      Inicio de sesión sin contraseña con la biometría del dispositivo (Face ID,
      Touch ID, Windows Hello, llaves de seguridad) vía WebAuthn, apps
      autenticadoras (TOTP) con códigos de respaldo, y gestión de
      sesiones/dispositivos.
  - name: Login social
    description: >-
      Registro e inicio de sesión sin contraseña con Google, Apple, Microsoft y
      Facebook vía token exchange. El front obtiene la credencial del proveedor;
      la API la verifica y emite la sesión CBPay.
paths:
  /v1/analytics/summary:
    get:
      tags:
        - Analytics
      summary: Resumen de la cuenta para dashboards
      description: >
        Aggregated view of the whole account flow in a single call: gross volume
        in/out, transaction counts, new banking users, per-service sections
        (payouts, payins, deposits, withdrawals, transfers, swaps, cards,
        banking, verifications, aml, contacts) with their dimensions (country,
        currency, method, status, chain, merchant), service spending and valued
        balances. Amounts are USD decimal strings; empty buckets are
        zero-filled. Account credential only.
      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: Account analytics summary.
          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 de sesión (de register/login) o llave de API (`pk_...`).
        `X-API-Key: <token>` se acepta como header alternativo.

````