> ## 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 por data

> Consulta o saldo total consolidado para uma data.

## Comportamento observado

* `providers` contém uma chave por tipo de processador habilitado no escopo documentado.
* Os processadores padrão mantêm `accountId` e `balance` preenchidos com o snapshot diário persistido.
* Para LBPay habilitada em modo live, `accountId` contém a conta quando há exatamente uma conta distinta e fica nulo nos outros casos. `balance` e `observed_at` ficam nulos porque o Gateway não atribui um saldo diário da LBPay nesta resposta.

> [!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/daily/total-balance/{date}
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/daily/total-balance/{date}:
    get:
      tags:
        - Saldos
      summary: Consultar saldo total por data
      description: Consulta o saldo total consolidado para uma data.
      operationId: reference_balances_daily-total
      parameters:
        - name: date
          in: path
          required: true
          description: Data de referência no formato YYYY-MM-DD.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Saldo total diário.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DailyTotalBalance'
              example:
                gross_balance: 1240.25
                net_balance: 1200.25
                providers:
                  sandbox_pix:
                    accountId: demo-account
                    balance: 950
                  lbpay:
                    accountId: null
                    balance: null
                    observed_at: null
        '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
        '404':
          description: Saldo diário não encontrado para a data e o estabelecimento.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message: DailyBalance not found.
                  status: 404
        '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:
    DailyTotalBalance:
      type: object
      additionalProperties: false
      properties:
        gross_balance:
          type: number
          description: Saldo bruto diário da carteira em reais.
        net_balance:
          type: number
          description: Saldo líquido diário da carteira em reais.
        providers:
          type: object
          description: Mapa cujo nome de cada chave é o processor_type habilitado.
          properties:
            lbpay:
              $ref: '#/components/schemas/LbpayDailyProviderBalance'
          additionalProperties:
            $ref: '#/components/schemas/DailyProviderBalance'
      required:
        - gross_balance
        - net_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
    LbpayDailyProviderBalance:
      type: object
      additionalProperties: false
      properties:
        accountId:
          type:
            - string
            - 'null'
          description: >-
            Identificador da conta quando há exatamente uma conta LBPay distinta
            habilitada.
        balance:
          type: 'null'
          description: O Gateway não atribui um saldo diário à LBPay nesta resposta.
        observed_at:
          type: 'null'
          description: >-
            O Gateway não registra uma observação de saldo da LBPay nesta
            resposta.
      required:
        - accountId
        - balance
        - observed_at
    DailyProviderBalance:
      type: object
      additionalProperties: false
      description: Saldo diário de um processador que expõe uma única conta.
      properties:
        accountId:
          type: string
          description: Conta cadastrada no processador.
        balance:
          type: number
          description: Saldo diário do processador em reais.
      required:
        - accountId
        - balance
  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.