> ## 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. # Prévia do ciclo de payouts: quem recebe, quanto e bloqueios ativos > Simula o fechamento do ciclo de payouts sem agendar nada: lista afiliados elegíveis, valores, afiliados bloqueados (com motivo) e totais consolidados. Por ser apenas uma simulação, não altera nada nem emite eventos. ## OpenAPI ````yaml /openapi.json post /payouts/preview 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: /payouts/preview: post: tags: - Payouts summary: 'Prévia do ciclo de payouts: quem recebe, quanto e bloqueios ativos' description: >- Simula o fechamento do ciclo de payouts sem agendar nada: lista afiliados elegíveis, valores, afiliados bloqueados (com motivo) e totais consolidados. Por ser apenas uma simulação, não altera nada nem emite eventos. operationId: previewPayoutRun requestBody: required: true content: application/json: schema: default: {} type: object properties: programId: type: string pattern: ^prog_[0-9A-HJKMNP-TV-Z]{26}$ description: >- Filtro opcional: restringe a simulação aos afiliados de um programa específico. example: prog_01J9Z3K8N2QF4T7B9XP0WMD5RC responses: '200': description: Default Response content: application/json: schema: type: object properties: eligible: type: array items: type: object properties: affiliateId: type: string description: Afiliado elegível ao pagamento neste ciclo. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateName: type: string description: Nome do afiliado elegível. example: Maria Silva method: type: string enum: - pix description: Método de pagamento que será usado para o afiliado. example: pix amountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor a pagar ao afiliado em centavos (ex.: 1990 = R$19,90). example: 25000 commissionCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Quantidade de comissões agregadas para o afiliado. example: 4 destination: type: object properties: method: type: string enum: - pix description: Método de pagamento do destino. example: pix pixKey: type: string description: Chave PIX do destino (quando `method` é `pix`). example: maria@exemplo.com pixKeyType: type: string enum: - cpf - cnpj - email - phone - random description: >- Tipo da chave PIX do destino (quando `method` é `pix`). example: email required: - method additionalProperties: false description: >- Destino de pagamento atual do afiliado (chave PIX/método). Snapshot só é congelado quando o payout é criado de fato. required: - affiliateId - affiliateName - method - amountCents - commissionCount - destination additionalProperties: false description: Afiliados elegíveis ao pagamento neste ciclo. blocked: type: array items: type: object properties: affiliateId: type: string description: Afiliado bloqueado neste ciclo. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateName: type: string description: Nome do afiliado bloqueado. example: João Souza reason: type: string enum: - banned - incomplete_payout_profile - fraud_review_open - pending_invoice - non_positive_balance - below_minimum description: Motivo do bloqueio do afiliado no fechamento. example: incomplete_payout_profile amountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor que seria pago ao afiliado caso não estivesse bloqueado, em centavos. example: 25000 commissionCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Quantidade de comissões que ficariam retidas para o afiliado. example: 4 required: - affiliateId - affiliateName - reason - amountCents - commissionCount additionalProperties: false description: >- Afiliados bloqueados no fechamento, com o respectivo motivo. totals: type: object properties: eligibleAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Soma dos valores elegíveis em centavos (ex.: 1990 = R$19,90). example: 100000 eligibleCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Quantidade de afiliados elegíveis. example: 12 blockedCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Quantidade de afiliados bloqueados. example: 3 required: - eligibleAmountCents - eligibleCount - blockedCount additionalProperties: false description: Totais consolidados do ciclo de fechamento. required: - eligible - blocked - totals 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`. ````