> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hg.cash/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar bancos (Venezuela)

> Devuelve el catálogo vigente de Venezuela. No es una lista fija.

`country` incluye `pais`, `nombre`, `moneda`, `banks`, `accountTypes`, `documentTypes` y `phoneCode`.
Los ítems del catálogo son `{value, label}`.

Los ítems de `onramp.banks` son `{id, name}`. El `bancoPago` del cash-in debe coincidir exactamente con `name`.
El payout envía `banco`, `tipoCuenta` y `tipoDocumento` como el `value` del catálogo. Las etiquetas de texto se aceptan por compatibilidad.

Si la integración de pago no está configurada, la API devuelve `500` con `code: VE_BANKS_PROVIDER_NOT_CONFIGURED`.
Un fallo al obtener la lista de bancos devuelve `502` con `code: VE_BANKS_PROVIDER_ERROR`.




## OpenAPI

````yaml /api-reference/openapi.es.yaml get /ve/banks
openapi: 3.1.0
info:
  title: HG.Cash API
  description: >
    # 🚀 API de transacciones HG.Cash


    API REST moderna para que los usuarios creen transacciones de salida desde
    sus cuentas.


    ## 🧾 Cómo funciona


    - HG.Cash asigna cuentas a su usuario

    - Cuando estas cuentas tienen movimientos (entrada o salida), HG.Cash
    notificará su backend usando la URL de webhook que configure en el panel de
    HG.Cash

    - **Firma de webhooks (HMAC)**: En la configuración de la cuenta puede
    generar un secreto de firma. Cuando está configurado, cada POST de webhook
    incluye el encabezado `X-HG-Webhook-Signature: sha256=<hex>` donde el valor
    es HMAC-SHA256 del cuerpo JSON sin procesar usando su secreto. Verifíquelo
    en su endpoint para asegurar que la solicitud es auténtica.

    - Para crear retiros (dinero que sale de sus cuentas), debe llamar al
    endpoint **Cash Out**: **Crear solicitud de transacción** (`POST
    /transactions`)


    ## 📊 Primeros pasos


    1. **Genere su token de API** en la página de configuración de la cuenta

    2. **Pruebe los endpoints** usando la documentación interactiva a
    continuación

    3. **Implemente** en sus servicios de backend (nunca exponga tokens en el
    frontend)

    4. **Supervise** su integración y maneje los errores adecuadamente


    ## 🔐 Autenticación


    Esta API usa autenticación **Bearer Token**. Incluya el token de API del
    usuario en el encabezado Authorization, por ejemplo `Authorization: Bearer
    cash_your_token_here`.


    ## ⚠️ Notas importantes de seguridad


    - Nunca comparta ni exponga su token de autenticación de API de usuario

    - Almacene los tokens de forma segura solo en sus servidores de backend

    - Todas las llamadas a la API deben realizarse desde servicios de backend
    seguros

    - Contacte a los administradores inmediatamente si su token se ve
    comprometido
  version: 1.0.0
  contact:
    name: HG.Cash API Support
    email: api-support@hg.cash
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://hg.cash/api/v1
    description: Servidor de producción
  - url: http://dev.hg.cash/api/v1
    description: Servidor de desarrollo
security:
  - bearerAuth: []
tags:
  - name: Transacciones
    description: >-
      Gestión de transacciones - Crear y administrar transacciones en el sistema
      HG.Cash. Todos los endpoints de transacciones requieren autenticación.
  - name: Cuentas
    description: >-
      Cuentas - Obtener información de cuentas y saldos del usuario autenticado.
      Todos los endpoints de cuentas requieren autenticación.
  - name: Datos de referencia
    description: >-
      Datos de referencia - Obtener datos de referencia como estados y tipos de
      transacción. Estos endpoints requieren autenticación.
  - name: Webhooks
    description: Webhooks - Notificaciones de eventos enviadas a su endpoint HTTP.
  - name: Brasil
    description: Brasil — Crear y consultar transacciones PIX (BRL).
  - name: Chile
    description: Chile — Checkout hospedado y payouts bancarios (CLP).
  - name: Bolivia
    description: Bolivia — Cash-in con QR y payouts ACH (BOB).
  - name: Colombia
    description: >-
      Colombia — Cash-in con checkout hospedado y payouts bancarios, llave Bre-B
      o QR Bre-B (COP).
  - name: Venezuela
    description: Venezuela — Cash-in y payouts en USDT.
  - name: Checkouts
    description: Sesiones de checkout hospedado para AR, BR, CL, BO y CO
  - name: Claims
    description: Reclamos con evidencia de comprobante de transferencia
paths:
  /ve/banks:
    get:
      tags:
        - Venezuela
      summary: Listar bancos (Venezuela)
      description: >
        Devuelve el catálogo vigente de Venezuela. No es una lista fija.


        `country` incluye `pais`, `nombre`, `moneda`, `banks`, `accountTypes`,
        `documentTypes` y `phoneCode`.

        Los ítems del catálogo son `{value, label}`.


        Los ítems de `onramp.banks` son `{id, name}`. El `bancoPago` del cash-in
        debe coincidir exactamente con `name`.

        El payout envía `banco`, `tipoCuenta` y `tipoDocumento` como el `value`
        del catálogo. Las etiquetas de texto se aceptan por compatibilidad.


        Si la integración de pago no está configurada, la API devuelve `500` con
        `code: VE_BANKS_PROVIDER_NOT_CONFIGURED`.

        Un fallo al obtener la lista de bancos devuelve `502` con `code:
        VE_BANKS_PROVIDER_ERROR`.
      operationId: listVeBanks
      responses:
        '200':
          description: Catálogo del país y bancos de entrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VenezuelaBanksResponse'
        '401':
          description: No autorizado
        '500':
          description: La integración de pago no está configurada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VenezuelaProviderError'
              example:
                error: The payment integration is not configured.
                code: VE_BANKS_PROVIDER_NOT_CONFIGURED
                type: provider_error
        '502':
          description: No se pudo obtener la lista de bancos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VenezuelaProviderError'
              example:
                error: Unable to fetch banks from the payment provider.
                code: VE_BANKS_PROVIDER_ERROR
                type: provider_error
components:
  schemas:
    VenezuelaBanksResponse:
      type: object
      required:
        - country
        - onramp
      description: >-
        Catálogo de bancos vigente. No es una lista fija. Los ítems del país son
        `{value, label}`. Los bancos de entrada son `{id, name}`.
      properties:
        country:
          type: object
          required:
            - pais
            - moneda
            - banks
            - accountTypes
            - documentTypes
          properties:
            pais:
              type: string
              example: VE
            nombre:
              type: string
            moneda:
              type: string
              example: VES
            banks:
              type: array
              items:
                $ref: '#/components/schemas/VenezuelaCatalogueOption'
            accountTypes:
              type: array
              items:
                $ref: '#/components/schemas/VenezuelaCatalogueOption'
            documentTypes:
              type: array
              items:
                $ref: '#/components/schemas/VenezuelaCatalogueOption'
            phoneCode:
              $ref: '#/components/schemas/VenezuelaCatalogueOption'
        onramp:
          type: object
          required:
            - currency
            - banks
            - total
          properties:
            currency:
              type: string
              example: VES
            total:
              type: integer
            banks:
              type: array
              description: >-
                Bancos del pagador para el cash-in. `bancoPago` debe coincidir
                exactamente con `name`.
              items:
                type: object
                required:
                  - name
                properties:
                  id:
                    type: integer
                  name:
                    type: string
    VenezuelaProviderError:
      type: object
      required:
        - error
        - code
        - type
      properties:
        error:
          type: string
        code:
          type: string
          enum:
            - VE_BANKS_PROVIDER_NOT_CONFIGURED
            - VE_BANKS_PROVIDER_ERROR
            - VE_INBOUND_INVALID_BANCO_PAGO
            - VE_INBOUND_PROVIDER_CREATE_FAILED
            - VE_INBOUND_PROVIDER_MISSING_ORDEN_ID
        type:
          type: string
          enum:
            - provider_error
            - provider_invalid_response
            - validation_error
    VenezuelaCatalogueOption:
      type: object
      required:
        - value
        - label
      description: >-
        Ítem del catálogo del país. Envíe `value` en los payouts. Las etiquetas
        de texto se aceptan por compatibilidad.
      properties:
        value:
          oneOf:
            - type: string
            - type: number
        label:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Token de autenticación de API de usuario con formato
        `cash_<64-char-hex>`. Valor de ejemplo
        `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.