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

# Listar payouts

> Devuelve los payouts de la cuenta que llama.



## OpenAPI

````yaml /openapi.es.yaml get /v1/payouts
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:
    get:
      tags:
        - Payouts
      summary: Listar payouts
      description: Devuelve los payouts de la cuenta que llama.
      operationId: listPayouts
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - processing
              - completed
              - failed
        - name: country
          in: query
          schema:
            type: string
          description: Filtra por pais de destino (ISO 3166-1 alfa-2, ej. CL, PE, MX).
        - name: from
          in: query
          schema:
            type: string
            format: date
          description: Filtra desde esta fecha (YYYY-MM-DD, UTC, inclusive).
        - name: to
          in: query
          schema:
            type: string
            format: date
          description: Filtra hasta esta fecha (YYYY-MM-DD, UTC, inclusive).
        - name: format
          in: query
          description: >-
            Exporta las mismas filas como archivo: `csv` o `xlsx` (descarga
            contable, hasta 10.000 filas; mismos filtros y rango). Omite para la
            vista JSON.
          schema:
            type: string
            enum:
              - csv
              - xlsx
      responses:
        '200':
          description: Payouts paginados.
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                  page_size:
                    type: integer
                  payouts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payout'
              example:
                page: 1
                page_size: 50
                payouts:
                  - payout_id: 7d5c2f0a-1e9b-4a6d-8f3c-0b2a1d9e8c7f
                    account_id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
                    idempotency_key: invoice-8841
                    country: MX
                    currency: MXN
                    method: bank_transfer
                    local_amount: '1500.00'
                    fx_rate: '17.50'
                    usdt_amount: '85.714286'
                    fee: '0.300000'
                    total_debit: '86.014286'
                    settlement_asset: USDT
                    settlement_amount: '86.014286'
                    settlement_rate: '1'
                    beneficiary:
                      name: Maria Lopez
                      account_type: clabe
                      account_number: 12180001234567896
                    description: Invoice 8841
                    status: processing
                    status_code: ''
                    status_message: ''
                    created_at: '2026-07-07T12:00:00Z'
                    updated_at: '2026-07-07T12:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
    pageSize:
      name: page_size
      in: query
      schema:
        type: integer
        default: 50
        maximum: 200
  schemas:
    Payout:
      type: object
      properties:
        payout_id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
        idempotency_key:
          type: string
        country:
          type: string
        currency:
          type: string
        method:
          type: string
        local_amount:
          type: string
        fx_rate:
          type: string
          description: >-
            La tasa de tu cuenta al momento de la ejecución (unidades locales
            por 1 USDT).
        usdt_amount:
          type: string
        fee:
          type: string
        total_debit:
          type: string
        settlement_asset:
          type: string
          enum:
            - USDT
            - USDC
            - BTC
            - GOLD
          description: Saldo virtual desde el que realmente se debitó la operación.
        settlement_amount:
          type: string
          description: >-
            Monto exacto debitado del saldo del asset de settlement (en unidades
            de ese asset). Es igual a `total_debit` cuando el asset es USDT. Si
            el payout falla se reembolsa este monto exacto — nunca se re-cotiza.
        settlement_rate:
          type: string
          description: >-
            Precio USD efectivo por unidad del asset de settlement usado para
            convertir el total en USDT ("1" para USDT/USDC).
        beneficiary:
          type: object
        description:
          type: string
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
        status_code:
          type: string
        status_message:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        idempotency_hit:
          type: boolean
          description: Presente (true) cuando la respuesta es una repetición idempotente.
    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
    Forbidden:
      description: Nivel de credencial no permitido para este endpoint (`forbidden`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: forbidden
            message: credentials required
  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.

````