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

# Resumo do saldo

> Retorna o total recebido (cobranças pagas), saques pendentes, total sacado e o valor disponível para saque.



## OpenAPI

````yaml /openapi.yaml get /withdrawals/summary
openapi: 3.1.0
info:
  title: V4Pay API
  version: 2.0.0
  description: >
    API do gateway de pagamentos V4Pay: autenticação, clientes, cobranças,
    cupons e emissão de Pix — cada lojista tem uma conta de recebimento no CNPJ
    dele, e a cobrança leva um split com a taxa do V4 Pay. Todas as rotas
    protegidas usam token JWT — o usuário é identificado pelo token, nunca por
    `user_id` no corpo da requisição.
servers:
  - url: https://v4pay-api.vercel.app
    description: Produção.
  - url: http://localhost:3000
    description: Ambiente local de desenvolvimento.
security: []
tags:
  - name: Pix
    description: Emitir e consultar cobranças Pix — o coração da API.
  - name: Cobranças
    description: Registro direto de cobranças e a listagem do histórico da loja.
  - name: Clientes
    description: Cadastro de pagadores para reutilizar nas cobranças.
  - name: Links de pagamento
    description: URLs públicas reutilizáveis que abrem o checkout com o valor definido.
  - name: Checkout (público)
    description: >-
      As rotas que a página de pagamento usa — sem autenticação, o pagador não
      tem conta.
  - name: Produtos
    description: Catálogo da loja; um produto pode virar cobrança ou link.
  - name: Cupons
    description: Descontos aplicados no checkout e na emissão por produto.
  - name: Assinaturas
    description: Cobrança recorrente, gerada por um cron diário.
  - name: Webhooks (endpoints)
    description: >-
      As URLs do seu servidor que recebem os eventos da loja, com assinatura
      HMAC.
  - name: Chaves de API
    description: Credenciais de integração (v4pay_test_ / v4pay_live_), revogáveis.
  - name: Conta de recebimento
    description: Cadastro da empresa e a conta que recebe — vale no modo subconta.
  - name: Aprovação de produção
    description: >-
      O fluxo para liberar a operação em produção — dados da empresa, documentos
      e análise da equipe.
  - name: Saques
    description: >-
      Pedidos de saque do saldo — suspensos no modo conta única
      (REPASSE_MANUAL).
  - name: Membros da loja
    description: Convites e papéis de quem opera a loja junto com o dono.
  - name: Conta (auth)
    description: Cadastro, login, perfil e a troca de ambiente da sessão.
  - name: Auditoria
    description: Trilha das ações feitas na loja, com quem fez e de onde.
  - name: Sistema
    description: Saúde da API.
  - name: Interno
    description: >-
      USO INTERNO DO PAINEL — documentado por transparência, não para
      integração: pode mudar sem aviso (Roadmap, aprovações da equipe, cron,
      login com Google, onboarding).
paths:
  /withdrawals/summary:
    get:
      tags:
        - Saques
      summary: Resumo do saldo
      description: >-
        Retorna o total recebido (cobranças pagas), saques pendentes, total
        sacado e o valor disponível para saque.
      responses:
        '200':
          description: Resumo retornado com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WithdrawalSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - bearerAuth: []
components:
  schemas:
    WithdrawalSummary:
      type: object
      description: Resumo financeiro para a tela de saques.
      properties:
        received_total:
          type: number
          format: double
          description: Soma das cobranças pagas.
          example: 3500
        pending_total:
          type: number
          format: double
          description: Soma dos saques pendentes.
          example: 500
        withdrawn_total:
          type: number
          format: double
          description: Soma dos saques concluídos.
          example: 1000
        available:
          type: number
          format: double
          description: Valor disponível para saque.
          example: 2000
    ErrorAuth:
      type: object
      description: >
        Segundo formato de erro, usado só pelo middleware de autenticação (token
        ausente, inválido ou chave revogada). Repare que aqui `error` é uma
        string, não um objeto.
      properties:
        error:
          type: string
          example: Token JWT ou chave de API ausente
  responses:
    Unauthorized:
      description: Não autenticado. Repare no formato — `error` é string neste caso.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorAuth'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Token JWT obtido em `/auth/login`, enviado no cabeçalho `Authorization`
        no formato `Bearer <token>`.

````