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

# Definir mis saldos predeterminados (payouts y payins)

> Cambia tus saldos predeterminados. `default_settlement_asset` es el saldo desde el que se debitan tus payouts y comisiones de servicios cuando el request no envía un `settlement_asset` explícito. `default_payin_asset` es el saldo en que se acreditan tus payins — el crédito sigue entrando en USDT y el neto se auto-convierte vía el motor de swaps al precio real, sin spread de swap adicional (el payin ya pagó su comisión y su tasa; los payins de checkout y POS conservan el asset de su link). Cualquiera de USDT, USDC, BTC o GOLD (si tu organización lo tiene habilitado). Envía uno o ambos campos. El cambio aplica solo a operaciones nuevas; nada en tránsito se re-cotiza.



## OpenAPI

````yaml /openapi.es.yaml put /v1/settlement
openapi: 3.1.0
info:
  title: CBPay API
  version: '2.62'
  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) — convertibles a demanda con swaps.
    Los payouts y las comisiones de servicios pueden pagarse desde cualquiera
    de los cuatro saldos (`PUT /v1/settlement` u override por payout con
    `settlement_asset`), y los payins pueden auto-convertirse al asset que
    elijas (`default_payin_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 (QR, transferencias, cuentas dedicadas, cobros pull,
      tarjetas, links de checkout) que se acreditan automáticamente — en USDT
      por defecto, o convertidas al settlement asset que elijas.
  - name: Checkout
    description: >-
      Links de checkout universal (`POST /v1/payins` con `method: "checkout"`) y
      los endpoints públicos de la página de pago — fiat multi-país, crypto con
      wallet efímera por link y pago directo CBPay, liquidado en el asset que
      elijas.
  - name: Tarjetas guardadas
    description: >-
      Tarjetas guardadas con el consentimiento explícito del pagador durante un
      pago 3-D Secure (COF). Listarlas, revocarlas y cobrarlas bajo demanda
      (MIT) sin pedir la tarjeta de nuevo.
  - name: Suscripciones
    description: >-
      Cobros recurrentes sobre una tarjeta guardada gestionados por el scheduler
      de la plataforma — diarios, semanales, mensuales o anuales, con
      pausa/reanudación/cancelación y dunning automático.
  - name: Transferencias
    description: >-
      Transferencias internas gratuitas entre cuentas CBPay (persona o empresa,
      cualquier combinación).
  - name: Contacts
    description: >-
      Libreta de beneficiarios por cuenta (destinos CBPay, bancarios y crypto)
      con match por teléfono y auto-guardado en cada envío.
  - name: Swaps
    description: >-
      Conversión instantánea entre los saldos USDT, USDC, BTC y GOLD de la
      cuenta a la tasa cotizada de la cuenta.
  - 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: Pruebas de firma
    description: >-
      Firma criptográfica de mensajes con wallets (EIP-191 ETH/EVM, TIP-191
      TRON) — crear, listar, consultar y revocar pruebas de firma con
      verificación pública.
  - name: Vínculos de wallets
    description: >-
      Vincula wallets externas (custody=client) a tu cuenta firmando un desafío
      nonce — crear desafíos, verificar firmas, listar y revocar vínculos.
  - 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
    description: >-
      Verificación de identidad: KYC para personas, KYB para empresas — tu
      propio onboarding y verificaciones de terceros para cuentas empresa.
  - 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: >-
      Screening AML standalone de personas y empresas contra listas de
      sanciones, PEP y medios adversos, con re-screening, monitoreo continuo e
      informe PDF descargable.
  - name: Qscore
    description: >-
      Buró de crédito API-first. Emite informes crediticios completos con score
      1-999 (bandas A-E, o SC cuando no hay datos), consulta el último score de
      un sujeto y gestiona disputas ARCO. Chile primero, con diseño agnóstico al
      país. Cada informe emitido lleva un código de verificación pública.
  - 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 que elijas
      (USDT, USDC, BTC o GOLD), 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.
  - name: Eventos en tiempo real
    description: >-
      Stream Server-Sent Events con todo lo que pasa en la cuenta (o en toda la
      organización para administradores), replay con `Last-Event-ID`, snapshot
      inicial opcional e historial consultable de 90 días.
paths:
  /v1/settlement:
    put:
      tags:
        - Cuenta
      summary: Definir mis saldos predeterminados (payouts y payins)
      description: >-
        Cambia tus saldos predeterminados. `default_settlement_asset` es el
        saldo desde el que se debitan tus payouts y comisiones de servicios
        cuando el request no envía un `settlement_asset` explícito.
        `default_payin_asset` es el saldo en que se acreditan tus payins — el
        crédito sigue entrando en USDT y el neto se auto-convierte vía el motor
        de swaps al precio real, sin spread de swap adicional (el payin ya pagó
        su comisión y su tasa; los payins de checkout y POS conservan el asset
        de su link). Cualquiera de USDT, USDC, BTC o GOLD (si tu organización lo
        tiene habilitado). Envía uno o ambos campos. El cambio aplica solo a
        operaciones nuevas; nada en tránsito se re-cotiza.
      operationId: updateSettlement
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                default_settlement_asset:
                  type: string
                  enum:
                    - USDT
                    - USDC
                    - BTC
                    - GOLD
                  description: >-
                    Saldo desde el que se debitan por defecto payouts y
                    comisiones. Opcional.
                default_payin_asset:
                  type: string
                  enum:
                    - USDT
                    - USDC
                    - BTC
                    - GOLD
                  description: >-
                    Saldo en que se acreditan por defecto los payins. El crédito
                    entra en USDT y el neto se auto-convierte vía el motor de
                    swaps al precio real (sin spread de swap adicional).
                    Opcional.
            example:
              default_settlement_asset: BTC
              default_payin_asset: USDC
      responses:
        '200':
          description: Configuración de settlement actualizada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementSettings'
              example:
                default_settlement_asset: BTC
                default_payin_asset: USDC
                enabled_assets:
                  - USDT
                  - USDC
                  - BTC
                  - GOLD
                volatile_op_limit_usdt: '10000.000000'
                volatile_daily_limit_usdt: '50000.000000'
        '400':
          description: >-
            Asset inválido o deshabilitado (`invalid_settlement_asset`,
            `settlement_asset_disabled`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: settlement_asset_disabled
                message: settlement asset is disabled for this organization
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountRequired'
components:
  schemas:
    SettlementSettings:
      type: object
      properties:
        default_settlement_asset:
          type: string
          enum:
            - USDT
            - USDC
            - BTC
            - GOLD
          description: >-
            Saldo desde el que se debitan las operaciones cuando no se envía un
            override por request.
        default_payin_asset:
          type: string
          enum:
            - USDT
            - USDC
            - BTC
            - GOLD
          description: >-
            Saldo en que se acreditan por defecto los payins. El crédito entra
            en USDT y el neto se auto-convierte vía el motor de swaps al precio
            real, sin spread de swap adicional. Checkout/POS conservan el asset
            de su link.
        enabled_assets:
          type: array
          items:
            type: string
          description: >-
            Assets que tu organización permite actualmente como origen del
            settlement.
        volatile_op_limit_usdt:
          type: string
          description: >-
            Límite por operación (equivalente en USDT) para los assets volátiles
            (BTC/GOLD).
        volatile_daily_limit_usdt:
          type: string
          description: >-
            Tope de volumen 24h (equivalente en USDT) por cuenta para los assets
            volátiles (BTC/GOLD).
      example:
        default_settlement_asset: USDT
        default_payin_asset: USDT
        enabled_assets:
          - USDT
          - USDC
          - BTC
          - GOLD
        volatile_op_limit_usdt: '10000.000000'
        volatile_daily_limit_usdt: '50000.000000'
    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.

````