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

# Escanear un QR de payout (Bolivia, Brasil)

> Paso 1 del payout por QR — Bolivia (QR interoperable local) y Brasil (QR PIX, incluyendo el código "copia e cola"): lee un QR de cobro y devuelve los datos del destinatario más el `provider_reference` necesario para confirmar. **Sin costo** — no se debita nada hasta el paso de confirmación. Por defecto es Bolivia; para Brasil envía `country: "BR"` y `currency: "BRL"`. Brasil soporta QR PIX **estáticos** (con la llave embebida); un QR dinámico (payload con URL del PSP) responde `400` — pide al beneficiario su llave PIX y usa el método `pix`. Un `amount` vacío en la respuesta del scan significa QR de monto abierto.



## OpenAPI

````yaml /openapi.es.yaml post /v1/payouts/qr/scan
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/payouts/qr/scan:
    post:
      tags:
        - Payouts
      summary: Escanear un QR de payout (Bolivia, Brasil)
      description: >-
        Paso 1 del payout por QR — Bolivia (QR interoperable local) y Brasil (QR
        PIX, incluyendo el código "copia e cola"): lee un QR de cobro y devuelve
        los datos del destinatario más el `provider_reference` necesario para
        confirmar. **Sin costo** — no se debita nada hasta el paso de
        confirmación. Por defecto es Bolivia; para Brasil envía `country: "BR"`
        y `currency: "BRL"`. Brasil soporta QR PIX **estáticos** (con la llave
        embebida); un QR dinámico (payload con URL del PSP) responde `400` —
        pide al beneficiario su llave PIX y usa el método `pix`. Un `amount`
        vacío en la respuesta del scan significa QR de monto abierto.
      operationId: payoutQrScan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - qr_payload
              properties:
                country:
                  type: string
                  enum:
                    - BO
                    - BR
                  default: BO
                currency:
                  type: string
                  enum:
                    - BOB
                    - USD
                    - BRL
                  default: BOB
                qr_payload:
                  type: string
                  description: >-
                    Contenido crudo del QR escaneado (en Brasil, también el
                    código PIX "copia e cola").
            example:
              qr_payload: <QR content>
              currency: BOB
      responses:
        '200':
          description: Datos del destinatario para la confirmación del usuario.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scan_id:
                    type: string
                  provider_reference:
                    type: string
                  beneficiary_name:
                    type: string
                  destination_account:
                    type: string
                  amount:
                    type: string
                  currency:
                    type: string
                  glosa:
                    type: string
                  status:
                    type: string
              example:
                scan_id: 5c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f
                provider_reference: QR-REF-889923
                beneficiary_name: Juan Quispe
                destination_account: '****4521'
                amount: '700.00'
                currency: BOB
                glosa: ''
                status: scanned
        '400':
          description: >-
            Falta qr_payload (invalid_request) o QR ilegible/no soportado
            (invalid_qr_payload — BR Code corrupto, checksum inválido o QR PIX
            dinámico; el mensaje explica la razón exacta).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_qr_payload
                message: >-
                  dynamic pix qr codes are not supported yet: pay with method
                  pix using the beneficiary pix key
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountRequired'
        '502':
          description: Core no disponible (core_unavailable).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: core_unavailable
                message: could not scan the QR
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
    AccountRequired:
      description: Este endpoint requiere una credencial de cuenta (`account_required`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: account_required
            message: this endpoint requires an account credential
  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.

````