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

# Account summary for 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.yaml get /v1/analytics/summary
openapi: 3.1.0
info:
  title: CBPay API
  version: '1.89'
  description: |
    CBPay is a multi-currency payment platform: fiat payouts and collections
    across Latin America, internal transfers, on-chain funding and
    withdrawals, and KYC screening. Every account holds four independent
    virtual balances — USDT (the operating currency), USDC, BTC and GOLD
    (grams of fine gold) — that never mix or convert automatically.
    Payouts and service fees can be paid from any of the four balances:
    set a default with `PUT /v1/settlement` or override per payout with
    `settlement_asset`.

    All amounts are decimal strings in each currency's precision (6 decimals
    for USDT/USDC/GOLD, 8 for BTC). Errors always return
    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (production, real money)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, simulated money — pk_test_ keys)
security:
  - bearerAuth: []
tags:
  - name: Receipts
    description: >-
      Branded PDF receipt per operation, with a public signed-QR authenticity
      check, receipt_url on every response/webhook and automatic email delivery
      on final states.
  - name: Authentication
    description: Register and log in account members. Sessions last 24 hours.
  - name: Account
    description: Profile, members and API keys of the calling account.
  - name: Balances
    description: Balances, movement history and FX rates.
  - name: Payouts
    description: >-
      Fiat dispersals debited from the settlement balance of your choice (USDT
      by default).
  - name: Payins
    description: Fiat top-ups credited to the USDT balance.
  - name: Transfers
  - name: Contacts
  - name: Swaps
    description: >-
      Free internal transfers between CBPay accounts (person or company, any
      combination).
  - name: Crypto
    description: On-chain funding and withdrawals (TRON, Ethereum and Bitcoin).
  - name: Segregated wallets
    description: >-
      On-chain wallets with their own balance (companies unlimited; persons 1
      per network+asset pair) — create, import, send, export the private key and
      auto-forward. The balance lives on-chain, never in the ledger.
  - name: QR Crypto POS
    description: >-
      Amount-bearing crypto QR charges for processors with physical POS
      terminals (company accounts): verified merchants, exclusive address + QR
      per charge, early payment detection, per-merchant reconciliation and
      refunds over the crypto withdrawal rail.
  - name: KYC / KYB
  - name: AML screening
    description: >-
      Identity verification: KYC for persons, KYB for companies, with AML
      screening, rescreening and continuous monitoring.
  - name: Wallet screening
    description: >-
      AML risk assessment of blockchain addresses (sanctions, illicit-fund
      exposure) with a per-scan fee, plus free automatic protection on
      withdrawals and deposits.
  - name: Analytics
  - name: Webhooks
    description: Subscriptions to receive signed event notifications.
  - name: Status
    description: Service availability.
  - name: Banking
    description: >-
      Real bank accounts: receive, hold and send money over international
      banking rails.
  - name: Cards
    description: >-
      Virtual and physical cards that spend Just-In-Time from the account's USDT
      balance, with per-card spending limits.
  - name: Security (OTP)
    description: >-
      One-time verification codes over SMS/WhatsApp/email protecting sensitive
      actions, plus self-service 2FA preferences. Applies to user sessions only
      — API keys are exempt.
  - name: Passkeys
    description: >-
      Passwordless sign-in with the device's biometrics (Face ID, Touch ID,
      Windows Hello, security keys) via WebAuthn, authenticator apps (TOTP) with
      backup codes, and session/device management.
  - name: Social login
    description: >-
      Passwordless sign up and sign in with Google, Apple, Microsoft and
      Facebook via token exchange. The front end obtains the provider
      credential; the API verifies it and issues the CBPay session.
paths:
  /v1/analytics/summary:
    get:
      tags:
        - Analytics
      summary: Account summary for 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: |
        Session JWT (from register/login) or API key (`pk_...`).
        `X-API-Key: <token>` is accepted as an alternative header.

````