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

# Get balance

> Retrieve the current merchant balance

Returns the current balance of the authenticated merchant.

All monetary values are in **cents** (e.g., `1500` = R\$15.00).

<Warning>
  Always use `withdrawNowAvailable` when creating a cashout. If `requiresFullWithdrawalNow` is `true`, your cashout request must use that exact amount.
</Warning>


## OpenAPI

````yaml api-reference/openapi.json GET /v1/balance
openapi: 3.1.1
info:
  title: Safefy - Pix Gateway
  description: >

    ## Introducao


    **Seu parceiro financeiro de confianca.**


    Nos somos a Safefy, uma plataforma especializada em solucoes de pagamento
    PIX. Com um servico personalizado e focado nas suas necessidades, estamos
    prontos para apoiar sua empresa em cada etapa do processo.


    - Conte com o **PIX** como metodo de pagamento rapido, seguro e alinhado com
    as melhores praticas de conformidade e prevencao a fraudes.

    - Gerencie suas financas de forma simples e acessivel por meio de uma
    interface completa e intuitiva.

    - Nosso time de suporte esta sempre disponivel para oferecer um atendimento
    exclusivo e eficiente.


    ## Precisa de Ajuda?


    A equipe da Safefy quer garantir que sua integracao seja um sucesso. Se
    tiver duvidas ou precisar de suporte, nao hesite em nos contatar:


    **suporte@safefypay.com.br**


    ---


    ## Valores Monetarios


    Todos os valores monetarios sao representados em **centavos** (menor unidade
    da moeda).


    | Valor Real | Valor na API |

    |------------|--------------|

    | R$ 1,00    | 100          |

    | R$ 10,50   | 1050         |

    | R$ 100,00  | 10000        |
  contact:
    name: Suporte Safefy
    email: suporte@safefypay.com.br
  version: v1
servers:
  - url: https://api-payment.safefypay.com.br
    description: API de Pagamentos Safefy
security:
  - bearerAuth: []
tags:
  - name: Autenticacao
    description: Endpoints de autenticacao OAuth2
  - name: Transacoes
    description: Gerenciamento de transacoes PIX
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Saldo
    description: Consulta de saldo e volumes
  - name: Saques
    description: Solicitacao e gerenciamento de saques
  - name: Disputas
    description: Consulta de disputas e envio de defesa
paths:
  /v1/balance:
    get:
      tags:
        - Saldo
      summary: Consultar saldo
      description: Retorna o saldo atual e volumes de transacoes da sua organizacao.
      operationId: getBalance
      responses:
        '200':
          description: Dados do saldo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBalanceResponse'
              example:
                data:
                  currency: BRL
                  balance:
                    available: 150000
                    pending: 25000
                    reserved: 0
                    total: 175000
                  totals:
                    lifetimeVolume: 5000000
                    lifetimePayouts: 4800000
                    lifetimeRefunds: 50000
                  period:
                    volumeToday: 100000
                    volumeThisWeek: 500000
                    volumeThisMonth: 2000000
                  updatedAt: '2025-01-15T15:00:00Z'
                message: null
                error: null
        '401':
          description: Nao autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBalanceResponse'
              example:
                data: null
                message: null
                error:
                  message: Token invalido ou expirado.
                  code: unauthorized
components:
  schemas:
    GetBalanceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BalanceData'
        message:
          type: string
          nullable: true
        error:
          $ref: '#/components/schemas/ApiErrorResponse'
    BalanceData:
      type: object
      nullable: true
      properties:
        currency:
          type: string
          description: Moeda
          example: BRL
        balance:
          $ref: '#/components/schemas/BalanceInfo'
        totals:
          $ref: '#/components/schemas/TotalsInfo'
        period:
          $ref: '#/components/schemas/PeriodInfo'
        updatedAt:
          type: string
          format: date-time
          description: Ultima atualizacao
          example: '2025-01-15T15:00:00Z'
    ApiErrorResponse:
      type: object
      nullable: true
      properties:
        message:
          type: string
          description: Mensagem de erro
          example: Token invalido ou expirado.
        code:
          type: string
          description: Codigo do erro
          example: unauthorized
    BalanceInfo:
      type: object
      properties:
        available:
          type: integer
          format: int64
          description: Saldo disponivel para saque (centavos)
          example: 150000
        pending:
          type: integer
          format: int64
          description: Saldo pendente de liquidacao (centavos)
          example: 25000
        reserved:
          type: integer
          format: int64
          description: Saldo reservado (centavos)
          example: 0
        total:
          type: integer
          format: int64
          description: Saldo total (centavos)
          example: 175000
    TotalsInfo:
      type: object
      properties:
        lifetimeVolume:
          type: integer
          format: int64
          description: Volume total recebido (centavos)
          example: 5000000
        lifetimePayouts:
          type: integer
          format: int64
          description: Total de saques realizados (centavos)
          example: 4800000
        lifetimeRefunds:
          type: integer
          format: int64
          description: Total de estornos (centavos)
          example: 50000
    PeriodInfo:
      type: object
      properties:
        volumeToday:
          type: integer
          format: int64
          description: Volume do dia atual (centavos)
          example: 100000
        volumeThisWeek:
          type: integer
          format: int64
          description: Volume dos ultimos 7 dias (centavos)
          example: 500000
        volumeThisMonth:
          type: integer
          format: int64
          description: Volume dos ultimos 30 dias (centavos)
          example: 2000000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token JWT obtido via /v1/auth/token

````