> ## 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) > Retorna o catálogo vigente da Venezuela. Não é uma lista fixa. `country` inclui `pais`, `nombre`, `moneda`, `banks`, `accountTypes`, `documentTypes` e `phoneCode`. Os itens do catálogo são `{value, label}`. Os itens de `onramp.banks` são `{id, name}`. O `bancoPago` do cash-in deve coincidir exatamente com `name`. O payout envia `banco`, `tipoCuenta` e `tipoDocumento` como o `value` do catálogo. Rótulos em texto são aceitos por compatibilidade. Se a integração de pagamento não estiver configurada, a API retorna `500` com `code: VE_BANKS_PROVIDER_NOT_CONFIGURED`. Uma falha ao buscar a lista de bancos retorna `502` com `code: VE_BANKS_PROVIDER_ERROR`. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.yaml get /ve/banks openapi: 3.1.0 info: title: HG.Cash API description: > # 🚀 API de transações HG.Cash API REST moderna para usuários criarem transações de saída a partir de suas contas. ## 🧾 Como funciona - A HG.Cash atribui contas ao seu usuário - Quando essas contas têm movimentação (entrada ou saída), a HG.Cash notifica o seu backend usando a URL de webhook configurada no painel - **Assinatura de webhooks (HMAC)**: Nas configurações da conta é possível gerar um segredo de assinatura. Quando configurado, cada POST de webhook inclui o cabeçalho `X-HG-Webhook-Signature: sha256=` com HMAC-SHA256 do corpo JSON usando o seu segredo. Verifique no seu endpoint para garantir autenticidade. - Para criar saques é necessário chamar o endpoint **Cash Out**: **Criar solicitação de transação** (`POST /transactions`) ## 📊 Primeiros passos 1. **Gere seu token de API** na página de configurações da conta 2. **Teste os endpoints** com a documentação interativa 3. **Implemente** nos seus serviços de backend (nunca exponha tokens no frontend) 4. **Monitore** a integração e trate erros adequadamente ## 🔐 Autenticação Esta API usa autenticação **Bearer Token**. Inclua o token de API do usuário no cabeçalho Authorization, por exemplo `Authorization: Bearer cash_your_token_here`. ## ⚠️ Segurança - Não compartilhe nem exponha o token de autenticação da API - Armazene tokens apenas em servidores backend seguros - Todas as chamadas devem ser feitas a partir de backends seguros - Se o token for comprometido, entre em contato com os administradores imediatamente 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 produção - url: http://dev.hg.cash/api/v1 description: Servidor de desenvolvimento security: - bearerAuth: [] tags: - name: Transações description: >- Gestão de transações — Criar e gerenciar transações no sistema HG.Cash. Todos os endpoints de transação exigem autenticação. - name: Contas description: >- Contas — Obter informações de conta e saldos do usuário autenticado. Todos os endpoints de conta exigem autenticação. - name: Dados de referência description: >- Dados de referência — Obter dados de referência como status e tipos de transação. Esses endpoints exigem autenticação. - name: Webhooks description: Webhooks — Notificações de eventos enviadas ao seu endpoint HTTP. - name: Brasil description: Brasil — Criar e consultar transações PIX (BRL). - name: Chile description: Chile — Checkout hospedado e payouts bancários (CLP). - name: Bolívia description: Bolívia — Cash-in com QR e payouts ACH (BOB). - name: Colômbia description: >- Colômbia — Cash-in com checkout hospedado e payouts bancários, chave Bre-B ou QR Bre-B (COP). - name: Venezuela description: Venezuela — Cash-in e payouts em USDT. - name: Checkouts description: Sessões de checkout hospedado para AR, BR, CL, BO e CO - name: Claims description: Reclamações com evidência de comprovante de transferência paths: /ve/banks: get: tags: - Venezuela summary: Listar bancos (Venezuela) description: > Retorna o catálogo vigente da Venezuela. Não é uma lista fixa. `country` inclui `pais`, `nombre`, `moneda`, `banks`, `accountTypes`, `documentTypes` e `phoneCode`. Os itens do catálogo são `{value, label}`. Os itens de `onramp.banks` são `{id, name}`. O `bancoPago` do cash-in deve coincidir exatamente com `name`. O payout envia `banco`, `tipoCuenta` e `tipoDocumento` como o `value` do catálogo. Rótulos em texto são aceitos por compatibilidade. Se a integração de pagamento não estiver configurada, a API retorna `500` com `code: VE_BANKS_PROVIDER_NOT_CONFIGURED`. Uma falha ao buscar a lista de bancos retorna `502` com `code: VE_BANKS_PROVIDER_ERROR`. operationId: listVeBanks responses: '200': description: Catálogo do país e bancos de entrada content: application/json: schema: $ref: '#/components/schemas/VenezuelaBanksResponse' '401': description: Não autorizado '500': description: A integração de pagamento não 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: Não foi possível buscar a 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. Não é uma lista fixa. Os itens do país são `{value, label}`. Os bancos de entrada são `{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 do pagador para o cash-in. `bancoPago` deve coincidir exatamente com `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: >- Item do catálogo do país. Envie `value` nos payouts. Rótulos em texto são aceitos por compatibilidade. properties: value: oneOf: - type: string - type: number label: type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Token de autenticação da API do usuário com o formato `cash_<64-char-hex>`. Valor de exemplo `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.