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

# Consultar saldo total atual

> Combina os saldos bruto e líquido da carteira com os saldos calculados para os processadores.

## Comportamento observado

* Cada item de `providers` usa o tipo do processador como chave. O conteúdo interno depende do processador.
* Uma falha na consulta de Zro Bank é registrada e esse processador pode ficar ausente do total devolvido.

> [!NOTE]
>
> Os exemplos usam identificadores e credenciais sintéticos. Os resultados do processador dependem do credenciamento e da configuração do estabelecimento.


## OpenAPI

````yaml openapi.json GET /api/merchant/current/total-balance
openapi: 3.1.0
info:
  title: Azentech Payments API
  version: 1.0.0
  description: >-
    Contrato HTTP público das operações de pagamento, consulta, sandbox e
    webhooks da Azentech. A especificação contém apenas o ambiente de
    homologação confirmado.
servers:
  - url: https://gateway.staging.azentech.dev
    description: Homologação (staging)
security: []
tags:
  - name: Pix
    description: Cobranças, pagamentos, aportes, retiradas e jornada biométrica.
  - name: Transações
    description: Consulta e reembolso de transações.
  - name: Saldos
    description: Saldos atuais, históricos e resumo financeiro.
  - name: Relatórios
    description: Extrato e posição financeira.
  - name: Sandbox
    description: Simulações disponíveis para processadores elegíveis em modo de teste.
paths:
  /api/merchant/current/total-balance:
    get:
      tags:
        - Saldos
      summary: Consultar saldo total atual
      description: >-
        Combina os saldos bruto e líquido da carteira com os saldos calculados
        para os processadores.
      operationId: reference_balances_current-total
      responses:
        '200':
          description: Saldos consolidados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TotalBalance'
              example:
                gross_balance: 1300.75
                net_balance: 1250.75
                providers_total_balance: 980.5
                providers:
                  - sandbox_pix:
                      accountId: demo-account
                      balance: 980.5
        '401':
          description: Token ausente, inválido ou sem acesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    base:
                      - Not authenticated
                  status: 401
        '500':
          description: Falha interna ou falha não traduzida do processador.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    fatal: >-
                      Something went wrong. Please refer to support with the
                      following code: 0000000000
                  status: 500
      security:
        - BearerAuth: []
components:
  schemas:
    TotalBalance:
      type: object
      additionalProperties: false
      properties:
        gross_balance:
          type: number
          description: Saldo bruto da carteira em reais.
        net_balance:
          type: number
          description: Saldo líquido da carteira em reais.
        providers_total_balance:
          type: number
          description: Soma dos saldos calculados para os processadores em reais.
        providers:
          type: array
          description: >-
            Um objeto por tipo de processador habilitado. O conteúdo depende do
            processador.
          items:
            type: object
            additionalProperties: true
      required:
        - gross_balance
        - net_balance
        - providers_total_balance
        - providers
    GatewayError:
      type: object
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            message:
              oneOf:
                - type: string
                - type: object
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              description: Mensagem simples ou mapa de campos para listas de mensagens.
            status:
              type: integer
              description: Código HTTP devolvido.
          required:
            - message
            - status
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: Token de acesso fornecido para o estabelecimento.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.