> ## 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. # Consulta um payout com seu snapshot de destino > Retorna um payout com seu snapshot de destino (fixado na criação). Use `expand=commissions` para incluir as comissões agregadas. ## OpenAPI ````yaml /openapi.json get /payouts/{payoutId} 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/{payoutId}: get: tags: - Payouts summary: Consulta um payout com seu snapshot de destino description: >- Retorna um payout com seu snapshot de destino (fixado na criação). Use `expand=commissions` para incluir as comissões agregadas. operationId: getPayout parameters: - schema: default: [] type: array items: type: string enum: - commissions in: query name: expand required: false description: >- Relações a expandir na resposta. Suporta `commissions` para incluir as comissões agregadas. - schema: type: string pattern: ^pay_[0-9A-HJKMNP-TV-Z]{26}$ example: pay_01J9Z3K8N2QF4T7B9XP0WMD5RC in: path name: payoutId required: true description: Identificador do payout (prefixo `pay_` + ULID). responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string description: Identificador único do payout (prefixo `pay_` + ULID). example: pay_01J9Z3K8N2QF4T7B9XP0WMD5RC organizationId: type: string description: Organização (tenant) dona do payout. example: org_01J9Z3K8N2QF4T7B9XP0WMD5RC affiliateId: type: string description: Afiliado beneficiário do payout. example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC batchId: anyOf: - type: string - type: 'null' description: >- Lote de fechamento (ciclo) ao qual o payout pertence. `null` em payouts anteriores aos lotes. example: cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC fundingId: anyOf: - type: string - type: 'null' description: >- Aporte (cobrança PIX) que cobre este payout, carimbado na autorização do lote. `null` enquanto o payout não entrou em nenhuma cobrança — sem cobertura ele não é distribuído. example: fund_01J9Z3K8N2QF4T7B9XP0WMD5RC status: type: string enum: - scheduled - processing - completed - failed - canceled description: Status atual do payout. example: scheduled method: type: string enum: - pix description: >- Método de pagamento registrado na criação do payout. Fica fixo a partir desse momento, mesmo que o afiliado altere o método depois. example: pix amountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: 'Valor total do payout em centavos (ex.: 1990 = R$19,90).' example: 25000 currency: type: string description: Moeda do payout (código ISO 4217). example: BRL commissionCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Quantidade de comissões agregadas neste payout. 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 do pagamento registrado na criação do payout. Fica fixo a partir desse momento, mesmo que o afiliado altere os dados depois. failureReason: anyOf: - type: string - type: 'null' description: >- Motivo da falha quando `status` é `failed`. `null` caso contrário. example: Chave PIX inválida providerTransactionId: anyOf: - type: string - type: 'null' description: >- ID da transação no provedor de pagamento. `null` enquanto não processado. example: txn_8f3c1a2b9d4e providerReceiptUrl: anyOf: - type: string - type: 'null' description: >- URL do comprovante de pagamento no provedor. `null` enquanto não pago. example: https://provedor.exemplo.com/receipts/txn_8f3c1a2b9d4e settlementSource: anyOf: - type: string enum: - provider - manual - type: 'null' description: >- Origem da liquidação. `provider`: transferência via gateway. `manual`: operador marcou como pago. `null` em payouts ainda não liquidados ou históricos. example: manual manualReceiptFileKey: anyOf: - type: string - type: 'null' description: >- Chave do comprovante anexado pelo operador (liquidação manual). Use `GET /payouts/{id}/receipt` para a URL assinada. example: org/org_…/payouts/pay_…/receipt_….pdf markedPaidByUserId: anyOf: - type: string - type: 'null' description: >- Usuário que marcou o payout como pago manualmente. `null` na liquidação via provedor. example: usr_01J9Z3K8N2QF4T7B9XP0WMD5RC scheduledAt: description: Data de agendamento do payout (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time processedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Data em que o payout entrou em processamento (ISO-8601). `null` enquanto agendado. example: '2026-06-13T12:05:00.000Z' paidAt: anyOf: - type: string format: date-time - type: 'null' description: >- Data do pagamento concluído (ISO-8601). `null` enquanto não pago. example: '2026-06-13T12:10:00.000Z' failedAt: anyOf: - type: string format: date-time - type: 'null' description: Data da falha (ISO-8601). `null` quando não falhou. example: '2026-06-13T12:10:00.000Z' canceledAt: anyOf: - type: string format: date-time - type: 'null' description: >- Data do cancelamento (ISO-8601). `null` quando não cancelado. example: '2026-06-13T12:10:00.000Z' createdAt: description: Data de criação do payout (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time updatedAt: description: Data da última atualização do payout (ISO-8601). example: '2026-06-13T12:00:00.000Z' type: string format: date-time commissions: type: array items: type: object properties: id: type: string description: >- Identificador único da comissão (prefixo `comm_` + ULID). example: comm_01J9Z3K8QXY4M2N6P7R0S1T2V3 organizationId: type: string description: >- Identificador da organização (tenant) dona da comissão. example: org_01J9Z3K8QXY4M2N6P7R0S1T2V3 programId: type: string description: >- Identificador do programa de afiliados ao qual a comissão pertence. example: prog_01J9Z3K8QXY4M2N6P7R0S1T2V3 affiliateId: type: string description: Identificador do afiliado que recebe a comissão. example: aff_01J9Z3K8QXY4M2N6P7R0S1T2V3 conversionId: anyOf: - type: string - type: 'null' description: >- Identificador da conversão que originou a comissão. `null` para bônus avulsos. example: conv_01J9Z3K8QXY4M2N6P7R0S1T2V3 type: type: string enum: - standard - clawback - bonus - adjustment description: >- Tipo da comissão. `standard`: comissão padrão gerada por uma conversão. `clawback`: estorno (valor negativo) por reembolso/chargeback. `bonus`: comissão avulsa concedida manualmente. `adjustment`: ajuste (delta) aplicado a uma comissão já paga quando ela é recalculada. example: standard status: type: string enum: - pending - approved - paid - voided description: >- Situação da comissão. `pending`: aguardando o fim do período de hold. `approved`: liberada e elegível para payout. `paid`: já incluída em um payout pago. `voided`: cancelada/anulada. example: pending underReview: type: boolean description: >- Indica se a comissão está retida em revisão (ex.: afiliado sob suspeita de fraude/ban). example: false billingCycle: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Ciclo de cobrança (1-based) para comissões recorrentes. `null` quando não recorrente. example: 1 amountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Valor da comissão em centavos. Pode ser negativo em estornos (clawback). example: 298 currency: type: string description: Moeda da comissão (ISO 4217). example: BRL 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 description: >- Memória de cálculo da comissão (regra aplicada, base, percentuais e detalhes específicos do tipo). holdUntil: anyOf: - type: string format: date-time - type: 'null' description: >- Data/hora (ISO-8601) até quando a comissão fica em hold antes de poder ser aprovada. example: '2026-07-13T12:00:00.000Z' sourceEventId: anyOf: - type: string - type: 'null' description: >- Identificador do evento de origem que gerou a comissão. example: evt_01J9Z3K8QXY4M2N6P7R0S1T2V3 originalCommissionId: anyOf: - type: string - type: 'null' description: >- Identificador da comissão original referenciada por um estorno ou ajuste. example: comm_01J9Z3K8QXY4M2N6P7R0S1T2V3 voidReason: anyOf: - type: string - type: 'null' description: >- Motivo informado ao anular a comissão. `null` quando não anulada. example: Pedido cancelado pelo cliente payoutId: anyOf: - type: string - type: 'null' description: >- Identificador do payout em que a comissão foi paga. `null` enquanto não paga. example: pay_01J9Z3K8QXY4M2N6P7R0S1T2V3 occurredAt: description: >- Data/hora (ISO-8601) em que o fato gerador da comissão ocorreu. example: '2026-06-13T12:00:00.000Z' type: string format: date-time approvedAt: anyOf: - type: string format: date-time - type: 'null' description: >- Data/hora (ISO-8601) em que a comissão foi aprovada. `null` enquanto pendente. example: '2026-07-13T12:00:00.000Z' createdAt: description: Data/hora (ISO-8601) de criação do registro. example: '2026-06-13T12:00:00.000Z' type: string format: date-time updatedAt: description: >- Data/hora (ISO-8601) da última atualização do registro. example: '2026-06-13T12:00:00.000Z' type: string format: date-time required: - id - organizationId - programId - affiliateId - conversionId - type - status - underReview - billingCycle - amountCents - currency - calculation - holdUntil - sourceEventId - originalCommissionId - voidReason - payoutId - occurredAt - approvedAt - createdAt - updatedAt additionalProperties: false description: >- Comissões agregadas no payout, incluídas quando `expand=commissions`. required: - id - organizationId - affiliateId - batchId - fundingId - status - method - amountCents - currency - commissionCount - destination - failureReason - providerTransactionId - providerReceiptUrl - settlementSource - manualReceiptFileKey - markedPaidByUserId - scheduledAt - processedAt - paidAt - failedAt - canceledAt - createdAt - updatedAt 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`. ````