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

# Previsualizar las instrucciones de depósito de un corredor

> Devuelve el texto de cuenta bancaria que tu organización publica para
un corredor `bank_transfer` — el mismo contenido que se embebe
automáticamente en la respuesta de un payin anunciado. Útil para
renderizar una pantalla "¿dónde envío la plata?" antes de que el
pagador cree el payin, o para mostrar las instrucciones vigentes en
una página estática.

Solo los corredores con una instrucción activa configurada por el
admin devuelven contenido; el resto responde `404 not_found` (nada
que previsualizar — el corredor no lo requiere o nadie lo configuró
aún).




## OpenAPI

````yaml /openapi.es.yaml get /v1/payins/deposit-instructions
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/payins/deposit-instructions:
    get:
      tags:
        - Payins
      summary: Previsualizar las instrucciones de depósito de un corredor
      description: |
        Devuelve el texto de cuenta bancaria que tu organización publica para
        un corredor `bank_transfer` — el mismo contenido que se embebe
        automáticamente en la respuesta de un payin anunciado. Útil para
        renderizar una pantalla "¿dónde envío la plata?" antes de que el
        pagador cree el payin, o para mostrar las instrucciones vigentes en
        una página estática.

        Solo los corredores con una instrucción activa configurada por el
        admin devuelven contenido; el resto responde `404 not_found` (nada
        que previsualizar — el corredor no lo requiere o nadie lo configuró
        aún).
      operationId: getDepositInstructions
      parameters:
        - name: country
          in: query
          required: true
          schema:
            type: string
          example: CL
        - name: currency
          in: query
          required: true
          schema:
            type: string
          example: CLP
        - name: method
          in: query
          schema:
            type: string
            default: bank_transfer
      responses:
        '200':
          description: Instrucciones de depósito activas del corredor.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deposit_instructions:
                    $ref: '#/components/schemas/DepositInstructions'
                  deposit_instructions_swift:
                    $ref: '#/components/schemas/DepositInstructions'
                    description: >-
                      Variante internacional SWIFT del corredor (solo US/USD,
                      cuando está configurada). Mismo shape, con su propio
                      `qr_payload` y `qr_png_base64`.
              examples:
                cl_bank_transfer:
                  summary: Chile (CLP)
                  value:
                    deposit_instructions:
                      id: 9f0c1a2b-3d4e-4f5a-8b9c-1a2b3c4d5e6f
                      country: CL
                      currency: CLP
                      method: bank_transfer
                      purpose: payin
                      revision: 3
                      active: true
                      reference_required: true
                      bank_name: Banco de Ejemplo
                      account_number: '0001112223'
                      account_type: checking
                      holder_name: Ejemplo Org SpA
                      created_at: '2026-07-15T14:02:00Z'
                      qr_payload: |
                        Bank: Banco de Ejemplo
                        Account type: checking
                        Account number: 0001112223
                        Holder: Ejemplo Org SpA
                      qr_png_base64: iVBORw0KGgoAAAANSU...
                us_bank_transfer:
                  summary: >-
                    Estados Unidos (USD — doble riel: ABA doméstico + SWIFT
                    internacional)
                  value:
                    deposit_instructions:
                      id: 7b1e4d5a-2c3b-4a59-8877-6f5e4d3c2b1a
                      country: US
                      currency: USD
                      method: bank_transfer
                      purpose: payin
                      revision: 1
                      active: true
                      reference_required: true
                      bank_name: Partner Bank, N.A.
                      account_number: '000123456789'
                      account_type: checking
                      holder_name: CBPay Operations LLC
                      holder_tax_id: 88-1234567
                      routing_number: '021000021'
                      holder_address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US
                      created_at: '2026-08-07T10:00:00Z'
                      qr_payload: >
                        Bank: Partner Bank, N.A.

                        Account type: checking

                        Account number: 000123456789

                        Routing number (ABA): 021000021

                        Holder: CBPay Operations LLC

                        Holder address: 25 SW 9th Street, Suite 406, Miami, FL
                        33130, US

                        Tax ID: 88-1234567
                      qr_png_base64: iVBORw0KGgoAAAANSU...
                    deposit_instructions_swift:
                      id: 8c2f5e6b-3d4c-5b6a-9988-7f6e5d4c3b2a
                      country: US
                      currency: USD
                      method: swift
                      purpose: payin
                      revision: 1
                      active: true
                      reference_required: true
                      bank_name: Partner Bank International
                      account_number: '9870001234'
                      account_type: checking
                      holder_name: CBPay Operations LLC
                      holder_tax_id: 88-1234567
                      swift: PRTBPRI3
                      bank_address: 200 Example Blvd, San Juan, PR 00901, PR
                      intermediary_bank_name: Intermediary Bank N.A.
                      intermediary_bank_swift: INTRUS33
                      holder_address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US
                      notes: Select Puerto Rico as the final beneficiary bank country
                      created_at: '2026-08-07T10:00:00Z'
                      qr_payload: >
                        Bank: Partner Bank International

                        Account type: checking

                        Account number: 9870001234

                        SWIFT: PRTBPRI3

                        Bank address: 200 Example Blvd, San Juan, PR 00901, PR

                        Intermediary bank: Intermediary Bank N.A.

                        Intermediary SWIFT: INTRUS33

                        Holder: CBPay Operations LLC

                        Holder address: 25 SW 9th Street, Suite 406, Miami, FL
                        33130, US

                        Tax ID: 88-1234567

                        Note: Select Puerto Rico as the final beneficiary bank
                        country
                      qr_png_base64: iVBORw0KGgoAAAANSU...
        '400':
          description: Faltan country o currency (invalid_payload).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_payload
                message: country and currency are required
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: >-
            No hay instrucciones de depósito activas para este corredor
            (not_found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: no deposit instructions configured for this corridor
components:
  schemas:
    DepositInstructions:
      type: object
      description: |
        El texto de cuenta bancaria que tu organización publica para un
        corredor `bank_transfer`. Administrado por el equipo admin,
        append-only (una revisión nueva jamás sobrescribe el texto que un
        payin ya congeló).
      properties:
        id:
          type: string
          format: uuid
        country:
          type: string
        currency:
          type: string
        method:
          type: string
        purpose:
          type: string
          enum:
            - payin
            - otc
        revision:
          type: integer
        active:
          type: boolean
        reference_required:
          type: boolean
        bank_name:
          type: string
        account_number:
          type: string
        account_type:
          type: string
        holder_name:
          type: string
        holder_tax_id:
          type: string
        holder_email:
          type: string
        routing_number:
          type: string
          description: >-
            Número de ruta ABA del banco destino (corredor US/USD — ACH y wires
            domésticos). Ausente en corredores que no lo usan.
        swift:
          type: string
          description: >-
            SWIFT/BIC del banco destino (corredor US/USD — wires
            internacionales). Ausente en corredores que no lo usan.
        bank_address:
          type: string
          description: >-
            Dirección registrada del banco destino. Presente cuando el banco del
            corredor la exige en el formulario de transferencia (US/USD).
        intermediary_bank_name:
          type: string
          description: >-
            Banco corresponsal (intermediario) — solo cuando la cuenta del
            corredor recibe wires internacionales a través de uno.
        intermediary_bank_swift:
          type: string
          description: SWIFT/BIC del banco corresponsal, cuando aplica.
        holder_address:
          type: string
          description: >-
            Dirección postal del titular de la cuenta. Los formularios de wire
            de los bancos de EE. UU. la exigen; el QR de cada riel incluye una
            línea "Holder address" cuando tiene valor.
        notes:
          type: string
          description: >-
            Nota operativa libre para el banco emisor (ej. qué país seleccionar
            como banco beneficiario final). Se muestra al pagador tal cual; el
            QR de cada riel incluye una línea "Note" cuando tiene valor.
        created_at:
          type: string
          format: date-time
        qr_payload:
          type: string
          description: |
            Texto plano multilínea con los datos bancarios (y, cuando el
            corredor lo exige, el monto y la referencia). Pensado para que
            lo lea una persona, no para que lo escanee una app bancaria.
        qr_png_base64:
          type: string
          description: |
            PNG en base64 que renderiza `qr_payload` como código QR, con el
            símbolo de marca de tu organización centrado.
    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.

````