> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uvvipay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar conta bancária

> Retorna a conta bancária ou chave PIX cadastrada na subconta.



## OpenAPI

````yaml GET /v1/submerchants/{internalId}/bank-account
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v1/submerchants/{internalId}/bank-account:
    get:
      tags:
        - Submerchants
      summary: Consultar conta bancária
      description: Retorna a conta bancária ou chave PIX cadastrada na subconta.
      operationId: getBankAccount
      parameters:
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
        - name: internalId
          required: true
          in: path
          description: Identificador interno (UUID) da subconta
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Conta bancária retornada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmerchantBankAccountResponseDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '404':
          description: Subconta não encontrada
        '429':
          description: Limite de requisições excedido
components:
  schemas:
    SubmerchantBankAccountResponseDto:
      type: object
      properties:
        bankingDataType:
          type: string
          description: Tipo dos dados bancários
          enum:
            - bank_account
            - chave_pix
          example: bank_account
        bankName:
          type: string
          description: Nome do banco
          example: banco do brasil
        bankAgency:
          type: string
          description: Agência bancária
          example: '1234'
        bankAccount:
          type: string
          description: Número da conta bancária
          example: '56789'
        bankAccountDv:
          type: string
          description: Dígito verificador da conta
          example: '0'
        bankAccountType:
          type: string
          description: Tipo da conta bancária
          enum:
            - conta_corrente
            - conta_poupanca
          example: conta_corrente
        bankCode:
          type: string
          description: Código do banco (compe)
          example: '001'
        ispb:
          type: string
          description: ISPB da instituição financeira
          example: '00000000'
        pixType:
          type: string
          enum:
            - cpf
            - cnpj
            - email
            - phone
            - EVP
          description: >-
            Tipo da chave PIX. Retornado exatamente como persistido, sem
            normalização.
          example: cpf
        pixKey:
          type: string
          description: Valor da chave PIX
          example: '12345678900'
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````