> ## 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. # Simula uma conversão sem persistir > Aplica atribuição, regra de comissão e antifraude ao afiliado informado sem criar conversão, comissão, clique ou evento. ## OpenAPI ````yaml /openapi.json post /programs/{programId}/conversions/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: /programs/{programId}/conversions/preview: post: tags: - Conversions summary: Simula uma conversão sem persistir description: >- Aplica atribuição, regra de comissão e antifraude ao afiliado informado sem criar conversão, comissão, clique ou evento. operationId: previewConversion parameters: - schema: type: string pattern: ^prog_[0-9A-HJKMNP-TV-Z]{26}$ in: path name: programId required: true requestBody: required: true content: application/json: schema: type: object properties: affiliateId: type: string pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$ description: >- Afiliado primário da simulação. Sem `touches`, recebe 100% do crédito (match manual). Com `touches`, ainda identifica o afiliado de referência da resposta. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC amountCents: type: integer minimum: 0 maximum: 900719925474 description: Valor simulado da conversão, em centavos. example: 10000 currency: default: BRL type: string enum: - BRL customerEmail: type: string maxLength: 254 format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ description: >- E-mail opcional do cliente simulado, usado na checagem de autoindicação. example: cliente@exemplo.com productId: type: string minLength: 1 maxLength: 255 description: >- Produto opcional usado para avaliar a aplicabilidade da regra. touches: minItems: 1 maxItems: 10 type: array items: type: object properties: affiliateId: type: string pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$ description: Afiliado do toque sintético na jornada simulada. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC offsetDays: type: integer minimum: 0 maximum: 365 description: >- Dias antes do momento da venda simulada em que o toque ocorreu (`0` = no momento da venda). example: 5 required: - affiliateId - offsetDays description: >- Jornada sintética de cliques. Quando presente, a simulação usa o motor real de atribuição do programa em vez do match manual de um único afiliado. couponAffiliateId: type: string pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$ description: >- Afiliado dono de um cupom sintético (sem persistir cupom). Combinado com `touches` para exercitar a política cupom×clique do programa. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC required: - affiliateId - amountCents responses: '200': description: Default Response content: application/json: schema: type: object properties: simulated: type: boolean enum: - true status: type: string enum: - pending - approved - voided - refunded description: >- Status da conversão. `pending`: aguardando revisão (ex.: travada por fraude). `approved`: aprovada e elegível a comissão. `voided`: anulada (manualmente ou por confirmação de fraude). `refunded`: estornada após reembolso do cliente. example: approved amountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 currency: type: string occurredAt: type: string format: date-time affiliate: type: object properties: id: type: string name: type: string status: type: string enum: - pending - approved - rejected - paused - banned description: >- Status do afiliado. `pending`: aguardando aprovação. `approved`: ativo, pode gerar comissões. `rejected`: cadastro recusado. `paused`: temporariamente suspenso. `banned`: banido permanentemente. example: approved required: - id - name - status additionalProperties: false journey: type: object properties: model: type: string enum: - first_click - last_click - linear - time_decay - position_based windowDays: type: integer minimum: -9007199254740991 maximum: 9007199254740991 matchMethod: type: string enum: - click_id - visitor_id - email_hash - fingerprint - coupon - manual description: >- Método usado para atribuir a conversão a um afiliado. `click_id`: clique identificado. `visitor_id`: visitante rastreado. `email_hash`: hash de e-mail do cliente. `fingerprint`: impressão digital do dispositivo. `coupon`: cupom de afiliado. `manual`: atribuição manual por operador. example: click_id couponPolicy: anyOf: - type: string enum: - coupon_wins - click_wins - split_50_50 - type: 'null' description: >- Política cupom×clique aplicada na simulação (`null` quando não houve conflito). touches: type: array items: type: object properties: kind: type: string enum: - click - coupon affiliateId: type: string affiliateName: type: string occurredAt: type: string format: date-time isWinner: type: boolean weightBps: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' clickId: anyOf: - type: string - type: 'null' required: - kind - affiliateId - affiliateName - occurredAt - isWinner - weightBps - clickId additionalProperties: false winners: type: array items: type: object properties: affiliateId: type: string affiliateName: type: string weightBps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 isPrimary: type: boolean required: - affiliateId - affiliateName - weightBps - isPrimary additionalProperties: false required: - model - windowDays - matchMethod - couponPolicy - touches - winners additionalProperties: false attribution: type: object properties: model: type: string enum: - first_click - last_click - linear - time_decay - position_based description: >- Modelo de atribuição aplicado. `first_click`: primeiro clique. `last_click`: último clique. `linear`: peso igual entre cliques. `time_decay`: peso maior para cliques recentes. `position_based`: peso maior nas pontas. example: last_click windowDays: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Janela de atribuição em dias considerada no matching. example: 30 matchMethod: type: string enum: - click_id - visitor_id - email_hash - fingerprint - coupon - manual description: >- Método usado para atribuir a conversão a um afiliado. `click_id`: clique identificado. `visitor_id`: visitante rastreado. `email_hash`: hash de e-mail do cliente. `fingerprint`: impressão digital do dispositivo. `coupon`: cupom de afiliado. `manual`: atribuição manual por operador. example: click_id gclid: type: string description: Google Click Identifier capturado na atribuição. example: Cj0KCQiA_gclid_example couponPolicy: type: string enum: - coupon_wins - click_wins - split_50_50 description: >- Política de desempate entre cupom e clique. `coupon_wins`: cupom prevalece. `click_wins`: clique prevalece. `split_50_50`: divide 50/50. example: click_wins candidates: type: array items: type: object properties: clickId: type: string description: Clique candidato avaliado na atribuição. example: clk_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateId: type: string description: Afiliado dono do clique candidato. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC occurredAt: type: string description: Data/hora do clique candidato (ISO-8601). example: '2026-06-10T09:30:00.000Z' required: - clickId - affiliateId - occurredAt additionalProperties: false description: Cliques candidatos avaliados durante a atribuição. winners: type: array items: type: object properties: clickId: anyOf: - type: string - type: 'null' description: >- Clique vencedor (`null` quando a atribuição não veio de clique). example: clk_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateId: type: string description: Afiliado premiado pela atribuição. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC weightBps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Peso da atribuição em basis points (10000 = 100% para o vencedor único). example: 10000 required: - clickId - affiliateId - weightBps additionalProperties: false description: Afiliados vencedores e seus pesos de atribuição. required: - model - windowDays - matchMethod - candidates - winners additionalProperties: false description: Snapshot da decisão de atribuição registrada na conversão. fraud: type: object properties: score: type: number description: >- Score de risco da conversão entre 0 (baixo) e 1 (alto). example: 0.12 decision: type: string enum: - approve - monitor - review - cleared - confirmed description: >- Decisão antifraude. `approve`: score abaixo do limite, aprovada automaticamente. `monitor`: aprovada, porém monitorada. `review`: travada para revisão manual. `cleared`: revisão manual concluiu falso positivo. `confirmed`: fraude confirmada (conversão anulada). example: approve signals: type: array items: type: object properties: key: type: string description: Identificador do sinal antifraude avaliado. example: ip_velocity weight: type: number description: Peso do sinal na composição do score. example: 0.3 triggered: type: boolean description: >- Indica se o sinal foi disparado para esta conversão. example: false detail: type: string description: Detalhe textual do sinal disparado. example: 3 conversões do mesmo IP em 1h required: - key - weight - triggered additionalProperties: false description: Sinais antifraude avaliados e seus pesos. policy: type: object properties: approveBelow: type: number description: >- Score abaixo do qual a conversão é aprovada automaticamente. example: 0.3 reviewAbove: type: number description: >- Score acima do qual a conversão é travada para revisão manual. example: 0.7 required: - approveBelow - reviewAbove additionalProperties: false description: >- Bandas de decisão antifraude vigentes no momento da avaliação. required: - score - decision - signals - policy additionalProperties: false description: Snapshot da avaliação antifraude registrada na conversão. rule: anyOf: - type: object properties: precedence: type: string enum: - custom - tier - default description: >- Origem da regra aplicada por precedência. `custom`: regra do afiliado. `tier`: regra do tier. `default`: regra padrão do programa. example: tier ruleId: type: string description: Identificador da regra de comissão aplicada. example: comm_01J9Z3K8N2QF4T7B9XP0WMD5RC version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Versão da regra vigente no momento da conversão. example: 3 type: type: string enum: - percentage - fixed - tiered description: >- Tipo da regra. `percentage`: percentual sobre o valor. `fixed`: valor fixo. `tiered`: por faixas de volume. example: percentage percentageBps: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Percentual da comissão em basis points. Ex.: 1500 = 15%. example: 1500 fixedAmountCents: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Valor fixo da comissão em centavos. Ex.: 1990 = R$ 19,90. example: 1990 recurrence: type: object properties: kind: type: string enum: - one_time - lifetime - months - decreasing description: >- Modo de recorrência da comissão. `one_time`: paga uma vez. `lifetime`: enquanto o cliente permanecer. `months`: por N ciclos. `decreasing`: percentual decrescente por ciclo. example: one_time months: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Número de ciclos pagos quando `kind` é `months`. example: 12 steps: type: array items: type: object properties: cycle: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Ciclo de cobrança (1 = primeiro ciclo). example: 1 percentageBps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Percentual do ciclo em basis points. Ex.: 1500 = 15%. example: 1500 required: - cycle - percentageBps additionalProperties: false description: >- Percentuais por ciclo quando `kind` é `decreasing`. required: - kind additionalProperties: false description: Configuração de recorrência da regra de comissão. tiers: anyOf: - type: array items: type: object properties: minCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Quantidade mínima de conversões para a faixa (a faixa base é 0). example: 0 percentageBps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Percentual da faixa em basis points. Ex.: 2000 = 20%. example: 2000 fixedAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Valor fixo da faixa em centavos. example: 5000 required: - minCount additionalProperties: false - type: 'null' description: >- Faixas da regra quando `type` é `tiered` (`null` caso contrário). applicableProductIds: anyOf: - type: array items: type: string - type: 'null' description: >- Produtos aos quais a regra se aplica. `null` significa todos os produtos. example: - plan_pro_monthly - plan_pro_yearly required: - precedence - ruleId - version - type - percentageBps - fixedAmountCents - recurrence - tiers - applicableProductIds additionalProperties: false description: Snapshot da regra de comissão aplicada na conversão. - type: 'null' commissions: type: array items: type: object properties: affiliateId: type: string affiliateName: type: string amountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 currency: type: string calculation: type: object properties: basis: type: string enum: - gross - net_of_gateway_fees description: >- Base de cálculo da comissão. `gross`: sobre o valor bruto cobrado. `net_of_gateway_fees`: sobre o valor líquido, descontando as taxas do gateway. example: gross chargedAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor cobrado do cliente, em centavos (ex.: 1990 = R$19,90). example: 1990 gatewayFeeCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Taxa do gateway descontada, em centavos. Presente quando `basis` é `net_of_gateway_fees`. example: 99 baseAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor base efetivamente usado no cálculo da comissão, em centavos. example: 1990 weightBps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Peso aplicado ao valor base, em basis points (ex.: 10000 = 100%). example: 10000 rule: type: object properties: ruleId: type: string description: Identificador da regra de comissão aplicada. example: cmrl_01J9Z3K8QXY4M2N6P7R0S1T2V3 version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Versão da regra de comissão aplicada (regras são imutáveis/versionadas). example: 1 precedence: type: string enum: - custom - tier - default description: >- Origem da regra que prevaleceu. `custom`: regra customizada do afiliado. `tier`: regra do tier. `default`: regra padrão do programa. example: default type: type: string enum: - percentage - fixed - tiered description: >- Modalidade de cálculo. `percentage`: percentual sobre a base. `fixed`: valor fixo por conversão. `tiered`: faixas progressivas por contagem de conversões. example: percentage required: - ruleId - version - precedence - type additionalProperties: false description: >- Regra de comissão aplicada (e sua versão) no momento do cálculo. appliedPercentageBps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Percentual efetivamente aplicado, em basis points (ex.: 1500 = 15%). example: 1500 appliedFixedAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Valor fixo efetivamente aplicado, em centavos. example: 500 recurrenceKind: type: string enum: - one_time - lifetime - months - decreasing description: >- Modelo de recorrência da comissão. `one_time`: paga uma única vez. `lifetime`: paga em toda renovação. `months`: paga por um número limitado de meses. `decreasing`: percentual decrescente a cada ciclo. example: one_time tier: type: object properties: minCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Contagem mínima de conversões da faixa que prevaleceu. example: 0 approvedConversionsCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Quantidade de conversões aprovadas do afiliado usada para escolher a faixa. example: 12 required: - minCount - approvedConversionsCount additionalProperties: false description: >- Faixa (tier) aplicada quando a regra é do tipo `tiered`. splitRemainderCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Resto (em centavos) não distribuído ao arredondar o split entre afiliados. example: 1 refund: type: object properties: refundedAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Valor reembolsado ao cliente, em centavos. example: 1990 chargedAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Valor originalmente cobrado, em centavos. example: 1990 originalCommissionAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor da comissão original que está sendo estornada, em centavos. example: 298 chargeback: type: boolean description: >- Indica se o estorno decorre de um chargeback (true) ou de um reembolso comum (false). example: false required: - refundedAmountCents - chargedAmountCents - originalCommissionAmountCents - chargeback additionalProperties: false description: >- Detalhamento do estorno (presente em comissões do tipo `clawback`). reprocess: type: object properties: jobId: type: string description: >- Identificador do job de reprocessamento que originou o ajuste. example: job_01J9Z3K8QXY4M2N6P7R0S1T2V3 originalAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor da comissão antes do recálculo, em centavos. example: 298 recalculatedAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor da comissão após o recálculo, em centavos. example: 350 required: - jobId - originalAmountCents - recalculatedAmountCents additionalProperties: false description: Referência do recálculo que gerou este ajuste. description: type: string description: >- Descrição livre do cálculo (ex.: motivo de um bônus). example: Bônus de campanha de junho required: - basis - chargedAmountCents - baseAmountCents - weightBps additionalProperties: false holdUntil: anyOf: - type: string format: date-time - type: 'null' required: - affiliateId - affiliateName - amountCents - currency - calculation - holdUntil additionalProperties: false skip: anyOf: - type: object properties: reason: type: string enum: - program_paused - affiliate_paused - self_referral - product_not_applicable - pending_confirmation description: >- Motivo pelo qual a comissão não foi gerada. `program_paused`: programa pausado. `affiliate_paused`: afiliado pausado. `self_referral`: autoindicação. `product_not_applicable`: produto fora dos `applicableProductIds` da regra vigente. `pending_confirmation`: conversão client-side aguardando confirmação via S2S (org não confia no client-side). example: affiliate_paused required: - reason additionalProperties: false - type: 'null' required: - simulated - status - amountCents - currency - occurredAt - affiliate - journey - attribution - fraud - rule - commissions - skip 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`. ````