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

# Obter saldo disponível

> Retorna o saldo disponível e bloqueado da conta.



## OpenAPI

````yaml /api-reference/openapi.yaml get /balance
openapi: 3.0.3
info:
  title: API Beehive Pay
  version: 1.0.0
  description: >
    API pública da Beehive Pay para criar e gerenciar transações, clientes,
    reembolsos,

    transferências, recebedores, contas bancárias, saldo, empresa, Payment
    Links.


    Autenticação:

    - Basic Authorization (ex.: "Basic base64(SECRET_KEY:x)")

    - ou x-api-key (se habilitado no seu gateway)
servers:
  - url: https://api.conta.paybeehive.com.br/v1
    description: Produção
security:
  - basicAuth: []
  - apiKeyAuth: []
tags:
  - name: transactions
    x-group: Transações
    description: Criação e consulta de transações (cartão, Pix e boleto).
  - name: refunds
    x-group: Reembolsos
    description: Estornos/reembolsos de transações.
  - name: customers
    x-group: Clientes
    description: Criação e consulta de clientes.
  - name: transfers
    x-group: Transferências
    description: Criação e consulta de transferências.
  - name: balance
    x-group: Saldo
    description: Consulta de saldo.
  - name: recipients
    x-group: Recebedores
    description: Criação e consulta de recebedores.
  - name: bank-accounts
    x-group: Contas Bancárias
    description: Adição e consulta de contas bancárias.
  - name: company
    x-group: Empresa
    description: Dados e atualização de dados da empresa.
  - name: payment-links
    x-group: Links de Pagamento
    description: Criação e atualização de payment links.
  - name: webhooks
    x-group: Webhooks
    description: Modelo de payloads de eventos enviados via webhook/postback.
paths:
  /balance:
    get:
      tags:
        - balance
      summary: Obter saldo disponível
      description: Retorna o saldo disponível e bloqueado da conta.
      operationId: getBalance
      responses:
        '200':
          description: Saldo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    Balance:
      type: object
      properties:
        available:
          type: integer
          example: 123456
        blocked:
          type: integer
          example: 0
        currency:
          type: string
          example: BRL
        updatedAt:
          type: string
          example: '2026-01-04T12:00:00Z'
    Error:
      type: object
      properties:
        message:
          type: string
          example: Invalid request
        code:
          type: string
          example: bad_request
        details:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Erro interno
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic Authorization usando SECRET_KEY como usuário e "x" como senha.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Header x-api-key (se habilitado).

````