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

# Cartola / estado de cuenta (JSON, PDF o Excel)

> Consolida todos los movimientos del período — payouts, payins, depósitos y retiros crypto, transferencias internas y cargos por servicio — en una cartola auditable con cuadratura exacta: opening_balance + total_in − total_out = closing_balance, verificada contra el ledger (`balanced`). El resumen y los movimientos cubren el saldo operativo USDT; cada otro saldo virtual (USDC, BTC, GOLD) con actividad concilia por separado dentro de `assets`. Pide `format=pdf` o `format=xlsx` para descargar el archivo con branding CBPay (Content-Disposition: attachment).



## OpenAPI

````yaml /openapi.es.yaml get /v1/reports/statement
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/reports/statement:
    get:
      tags:
        - Saldos
      summary: Cartola / estado de cuenta (JSON, PDF o Excel)
      description: >-
        Consolida todos los movimientos del período — payouts, payins, depósitos
        y retiros crypto, transferencias internas y cargos por servicio — en una
        cartola auditable con cuadratura exacta: opening_balance + total_in −
        total_out = closing_balance, verificada contra el ledger (`balanced`).
        El resumen y los movimientos cubren el saldo operativo USDT; cada otro
        saldo virtual (USDC, BTC, GOLD) con actividad concilia por separado
        dentro de `assets`. Pide `format=pdf` o `format=xlsx` para descargar el
        archivo con branding CBPay (Content-Disposition: attachment).
      operationId: getAccountStatement
      parameters:
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date
          description: Fecha inicial (YYYY-MM-DD, UTC, inclusive).
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date
          description: 'Fecha final (YYYY-MM-DD, UTC, inclusive). Rango máximo: 400 días.'
        - name: format
          in: query
          schema:
            type: string
            enum:
              - json
              - pdf
              - xlsx
            default: json
          description: json para la vista web; pdf/xlsx descargan el archivo con branding.
        - name: lang
          in: query
          schema:
            type: string
            enum:
              - es
              - en
            default: es
          description: Idioma del PDF/Excel.
      responses:
        '200':
          description: La cartola (JSON) o los bytes del archivo (pdf/xlsx).
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                account:
                  account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                  display_name: Example Company SpA
                  email: ops@example.com
                  type: company
                period:
                  from: '2026-01-01'
                  to: '2026-07-07'
                  timezone: UTC
                generated_at: '2026-07-07T15:00:00Z'
                summary:
                  opening_balance: '0.000000'
                  total_in: '985633.540000'
                  total_out: '38099.870000'
                  net_change: '947533.670000'
                  closing_balance: '947533.670000'
                  balanced: true
                  counts:
                    payouts: 51
                    payins: 12
                    crypto_deposits: 18
                    crypto_withdrawals: 3
                    transfers: 4
                    service_charges: 2
                    movements: 771
                  fees_by_service:
                    payout: '15.300000'
                    funding: '897.550000'
                  total_fees: '912.850000'
                assets:
                  - asset: GOLD
                    opening_balance: '0.000000'
                    total_in: '12.500000'
                    total_out: '2.000000'
                    net_change: '10.500000'
                    closing_balance: '10.500000'
                    balanced: true
                    movements:
                      - created_at: '2026-07-09T10:00:00Z'
                        type: adjustment
                        reference: adjustment gold-load-1
                        amount: '12.500000'
                        balance_after: '12.500000'
                breakdown:
                  by_product:
                    - product: payouts
                      count: 51
                      usdt_in: '0.000000'
                      usdt_out: '38099.870000'
                      fees: '15.300000'
                  by_country:
                    - flow: payouts
                      country: BO
                      currency: BOB
                      count: 14
                      local_amount: '28748.58'
                      usdt_amount: '2902.210000'
                  by_currency:
                    - currency: BOB
                      payout_local: '28748.58'
                      payin_local: '700.00'
                  by_month:
                    - month: 2026-01
                      usdt_in: '985633.540000'
                      usdt_out: '35100.000000'
                payouts:
                  - created_at: '2026-03-19T22:57:00Z'
                    payout_id: 0d4f2a10-1b2c-3d4e-5f60-718293a4b5c6
                    idempotency_key: bo-90
                    country: BO
                    currency: BOB
                    method: bank_transfer
                    beneficiary: Juan Quispe
                    detail: '1234567890'
                    local_amount: '90.00'
                    fx_rate: '6.91'
                    usdt_amount: '13.024600'
                    fee: '0.300000'
                    fee_percent: '0.200000'
                    fee_fixed: '0.100000'
                    total_debit: '13.324600'
                    status: completed
                payins: []
                crypto_deposits: []
                crypto_withdrawals: []
                transfers: []
                card_transactions:
                  - created_at: '2026-03-20T10:12:00Z'
                    transaction_id: 5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c
                    card_id: c0de0791-0000-0000-0000-000000000003
                    kind: purchase
                    merchant: AMAZON.COM
                    amount_usd: '25.00'
                    spend_asset: USDT
                    spend_amount: '25.000000'
                    status: settled
                swaps:
                  - created_at: '2026-03-21T09:00:00Z'
                    swap_id: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
                    from_asset: USDT
                    to_asset: BTC
                    from_amount: '10.000000'
                    to_amount: '0.00015433'
                    rate: '0.00001543'
                    status: completed
                banking_operations:
                  - created_at: '2026-03-22T14:30:00Z'
                    operation_id: 2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e
                    direction: out
                    type: wire
                    currency: USD
                    amount: '150.00'
                    counterparty: Acme Inc
                    status: completed
                service_charges:
                  - created_at: '2026-03-23T08:00:00Z'
                    type: banking_fee
                    service: banking_customer
                    fee_model: fixed
                    reference: cust-001
                    amount: '-0.500000'
                    balance_after: '139.100000'
                movements:
                  - created_at: '2026-03-19T22:57:00Z'
                    type: payout_debit
                    reference: payout 0d4f2a10-1b2c-3d4e-5f60-718293a4b5c6
                    amount: '-13.324600'
                    balance_after: '139.600000'
        '400':
          description: invalid_range / invalid_format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_range
                message: from and to are required (YYYY-MM-DD)
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Código de error legible por máquina (snake_case).
          example: insufficient_funds
        message:
          type: string
          description: Explicación legible por humanos.
  responses:
    Unauthorized:
      description: Credencial faltante o inválida (`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 de sesión (de register/login) o llave de API (`pk_...`).
        `X-API-Key: <token>` se acepta como header alternativo.

````