> ## 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 statement (JSON, PDF or Excel)

> Consolidates every movement of the period — payouts, payins, crypto deposits and withdrawals, internal transfers and service charges — into one auditable statement with an exact reconciliation: opening_balance + total_in − total_out = closing_balance, verified against the ledger (`balanced`). The summary and movements cover the USDT operating balance; every other virtual balance (USDC, BTC, GOLD) with activity reconciles independently inside `assets`. Request `format=pdf` or `format=xlsx` to download the CBPay-branded file (Content-Disposition: attachment).



## OpenAPI

````yaml /openapi.yaml get /v1/reports/statement
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/reports/statement:
    get:
      tags:
        - Balances
      summary: Account statement (JSON, PDF or Excel)
      description: >-
        Consolidates every movement of the period — payouts, payins, crypto
        deposits and withdrawals, internal transfers and service charges — into
        one auditable statement with an exact reconciliation: opening_balance +
        total_in − total_out = closing_balance, verified against the ledger
        (`balanced`). The summary and movements cover the USDT operating
        balance; every other virtual balance (USDC, BTC, GOLD) with activity
        reconciles independently inside `assets`. Request `format=pdf` or
        `format=xlsx` to download the CBPay-branded file (Content-Disposition:
        attachment).
      operationId: getAccountStatement
      parameters:
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date
          description: Start date (YYYY-MM-DD, UTC, inclusive).
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date
          description: 'End date (YYYY-MM-DD, UTC, inclusive). Max range: 400 days.'
        - name: format
          in: query
          schema:
            type: string
            enum:
              - json
              - pdf
              - xlsx
            default: json
          description: json for the web view; pdf/xlsx download the branded file.
        - name: lang
          in: query
          schema:
            type: string
            enum:
              - es
              - en
            default: es
          description: Language of the PDF/Excel output.
      responses:
        '200':
          description: The statement (JSON) or the file bytes (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: Machine-readable error code (snake_case).
          example: insufficient_funds
        message:
          type: string
          description: Human-readable explanation.
  responses:
    Unauthorized:
      description: Missing or invalid credential (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
  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.

````