> ## 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 resumo financeiro

> Agrega entradas e saídas por origem para estabelecimentos de apostas.

## Comportamento observado

* Envie as duas datas. Se uma data estiver ausente ou inválida, o Gateway aplica valores padrão que podem formar um intervalo invertido.
* A rota está limitada a 1.000 requisições por minuto pelo middleware atual.

> [!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/balance-report
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/balance-report:
    get:
      tags:
        - Saldos
      summary: Consultar resumo financeiro
      description: Agrega entradas e saídas por origem para estabelecimentos de apostas.
      operationId: reference_balances_report
      parameters:
        - name: from
          in: query
          required: false
          description: Data inicial em YYYY-MM-DD.
          schema:
            type: string
            format: date
        - name: to
          in: query
          required: false
          description: Data final em YYYY-MM-DD.
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Resumo por fluxo e origem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceReport'
              example:
                total:
                  cash_in:
                    player:
                      counter: 12
                      total_amount: '1250.00'
                    funding:
                      counter: 1
                      total_amount: '500.00'
                  cash_out:
                    player:
                      counter: 5
                      total_amount: '425.00'
                    profit_withdrawal:
                      counter: 1
                      total_amount: '100.00'
                    fee:
                      total_amount: '12.50'
        '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
        '403':
          description: Disponível apenas para estabelecimentos de apostas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    base:
                      - Not available for merchant
                  status: 403
        '429':
          description: Limite da rota excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    base:
                      - Too Many Attempts.
                  status: 429
        '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:
    BalanceReport:
      type: object
      additionalProperties: false
      properties:
        total:
          type: object
          additionalProperties: false
          properties:
            cash_in:
              type: object
              properties:
                player:
                  $ref: '#/components/schemas/CounterAmount'
                funding:
                  $ref: '#/components/schemas/CounterAmount'
              required:
                - player
                - funding
            cash_out:
              type: object
              properties:
                player:
                  $ref: '#/components/schemas/CounterAmount'
                profit_withdrawal:
                  $ref: '#/components/schemas/CounterAmount'
                fee:
                  type: object
                  properties:
                    total_amount:
                      type: string
                  required:
                    - total_amount
              required:
                - player
                - profit_withdrawal
                - fee
          required:
            - cash_in
            - cash_out
      required:
        - total
    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
    CounterAmount:
      type: object
      additionalProperties: false
      properties:
        counter:
          type: integer
          description: Quantidade de transações.
          minimum: 0
        total_amount:
          type: string
          description: Valor total em reais, com duas casas decimais.
      required:
        - counter
        - total_amount
  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.