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

# Saldo da conta

> Retorna o saldo disponível e saldo retido da conta



## OpenAPI

````yaml GET /users/account/balance
openapi: 3.0.1
info:
  title: 3X Pay Gateway
  description: >-
    Para autenticar as rotas dessa API são necessario ter em mãos a
    **api_secret** e **api_key** da sua conta. Este podem ser encontrados dentro
    do painel https://app.3xpay.co acessando a página de Configurações e
    clicando na opção de Credencias de API.
  version: 1.0.0
servers:
  - url: https://gateway.3xpay.co
security:
  - apiKeyAuth: []
    apiSecretAuth: []
tags:
  - name: Transações
    description: Operações relacionadas a transações financeiras
  - name: Webhooks
    description: Notificações de eventos da API
  - name: Balance
    description: Operações relacionadas ao saldo da conta
  - name: Sub-accounts
    description: Operações relacionadas a subcontas BaaS
  - name: MED Contest
    description: >-
      Endpoints server-to-server para responder a solicitações de MED (Mecanismo
      Especial de Devolução do Pix)
paths:
  /users/account/balance:
    get:
      tags:
        - Balance
      summary: Consultar Saldo
      description: Retorna o saldo disponível e saldo retido da conta
      operationId: getBalance
      responses:
        '200':
          description: Saldo consultado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
components:
  schemas:
    BalanceResponse:
      type: object
      properties:
        balance:
          type: number
          description: Saldo disponível na conta
          example: 7.56
        secure_balance:
          type: number
          description: Saldo retido/em garantia
          example: 10.28
        total_meds:
          type: number
          description: Total de MEDs
          example: 10.28
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api_key
    apiSecretAuth:
      type: apiKey
      in: header
      name: api_secret

````