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

# Saldo do afiliado: pendente, aprovado não pago, estornos e projeção do próximo payout

> Retorna o saldo financeiro do afiliado: comissões pendentes, aprovadas não pagas, estornos (clawbacks) e a projeção do próximo payout. Valores em centavos.



## OpenAPI

````yaml /openapi.json get /affiliates/{affiliateId}/balance
openapi: 3.1.0
info:
  title: Repass API
  description: >-
    API pública do Repass — plataforma de gestão de afiliados: programas, links,
    tracking, atribuição, conversões, comissões, payouts, fiscal (BR),
    reprocessamento, event store e webhooks.
  version: 0.1.0
servers:
  - url: https://api.userepass.com
    description: Produção
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Profile
    description: Perfil do usuário autenticado.
  - name: Guide
    description: >-
      Guia de onboarding do painel: estado de tours, telas visitadas e
      preferências por usuário e organização.
  - name: Portal
    description: >-
      Portal do afiliado: sessão por identidade de afiliado (sem org), convites
      e claim.
  - name: Programs
    description: 'Programas de afiliados: configuração, atribuição, hold e tiers.'
  - name: Commission Rules
    description: Regras de comissão versionadas (imutáveis) por programa.
  - name: Affiliates
    description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.'
  - name: Terms
    description: Termos do programa, versionados.
  - name: Materials
    description: >-
      Materiais (criativos) do programa: upload pelo gestor e download pelos
      afiliados.
  - name: Links
    description: Links rastreáveis e domínios de redirecionamento.
  - name: Coupons
    description: Cupons de afiliado e sync com gateway.
  - name: Pagamentos por PIX
    description: Habilitação de pagamentos por PIX (onboarding e documentos).
  - name: Tracking
    description: Endpoints públicos de redirect e registro de cliques.
  - name: Clicks
    description: Consulta de cliques e estatísticas de link.
  - name: Conversions
    description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.'
  - name: Commissions
    description: Comissões calculadas, holds, aprovação, void e clawback.
  - name: Payouts
    description: Ciclos de pagamento, prévia, execução e comprovantes.
  - name: Invoices
    description: Notas fiscais (PJ), envio e validação (BR).
  - name: Fraud
    description: Fila de revisão e decisões de fraude.
  - name: Reprocess
    description: Reprocessamento com dry-run obrigatório e relatório de impacto.
  - name: Events
    description: Histórico de eventos para auditoria e consulta.
  - name: Notifications
    description: >-
      Notificações ao operador (falhas de sincronização, payouts e afins) —
      registro in-app espelhado por e-mail aos owners/admins.
  - name: Webhooks
    description: Endpoints de webhook, entregas, retries e dead-letter.
  - name: Ingest
    description: Ingestão de eventos de cobrança (S2S e gateways).
  - name: Settings
    description: Configurações por organização (políticas e integrações).
  - name: Billing
    description: 'Plano e cobrança: contadores de uso da organização para o painel.'
  - name: Dashboard
    description: >-
      Métricas agregadas da operação (receita, top afiliados, conversões,
      comissões, novos afiliados) para a home e os relatórios do gestor.
  - name: Health
    description: Liveness do serviço.
paths:
  /affiliates/{affiliateId}/balance:
    get:
      tags:
        - Commissions
      summary: >-
        Saldo do afiliado: pendente, aprovado não pago, estornos e projeção do
        próximo payout
      description: >-
        Retorna o saldo financeiro do afiliado: comissões pendentes, aprovadas
        não pagas, estornos (clawbacks) e a projeção do próximo payout. Valores
        em centavos.
      operationId: getAffiliateBalance
      parameters:
        - schema:
            type: string
            pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$
          in: path
          name: affiliateId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  affiliateId:
                    type: string
                    description: Identificador do afiliado a que o saldo se refere.
                    example: aff_01J9Z3K8QXY4M2N6P7R0S1T2V3
                  currency:
                    type: string
                    description: Moeda dos valores do saldo (ISO 4217).
                    example: BRL
                  pendingCents:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Total de comissões pendentes (ainda em hold), em centavos.
                    example: 12500
                  approvedCents:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Total de comissões aprovadas e elegíveis a payout, em
                      centavos.
                    example: 8900
                  underReviewCents:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Total de comissões retidas em revisão, em centavos.
                    example: 0
                  clawbackCents:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Total de estornos (clawback) acumulados, em centavos
                      (valor negativo abate o saldo).
                    example: -298
                  nextPayoutProjectionCents:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Projeção do valor líquido do próximo payout, em centavos
                      (aprovado menos clawbacks).
                    example: 8602
                required:
                  - affiliateId
                  - currency
                  - pendingCents
                  - approvedCents
                  - underReviewCents
                  - clawbackCents
                  - nextPayoutProjectionCents
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer
        rstr_...`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`.

````