> ## 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.

# Envelope completo do evento (payload + metadados)

> Retorna o envelope completo de um único evento de domínio da organização (payload, metadados de ator/origem e timestamps de ocorrência e gravação). Retorna 404 se o evento não existir ou pertencer a outra organização.



## OpenAPI

````yaml /openapi.json get /events/{eventId}
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:
  /events/{eventId}:
    get:
      tags:
        - Events
      summary: Envelope completo do evento (payload + metadados)
      description: >-
        Retorna o envelope completo de um único evento de domínio da organização
        (payload, metadados de ator/origem e timestamps de ocorrência e
        gravação). Retorna 404 se o evento não existir ou pertencer a outra
        organização.
      operationId: getEvent
      parameters:
        - schema:
            type: string
            pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$
            example: evt_01J9Z3K8N2QF4T7B9XP0WMD5RC
          in: path
          name: eventId
          required: true
          description: Identificador do evento de domínio (prefixo `evt_` + ULID).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: >-
                      Identificador único do evento de domínio (prefixo `evt_` +
                      ULID).
                    example: evt_01J9Z3K8N2QF4T7B9XP0WMD5RC
                  organizationId:
                    type: string
                    description: Organização dona do evento.
                    example: org_01J9Z3K8N2QF4T7B9XP0WMD5RC
                  type:
                    type: string
                    description: >-
                      Tipo do evento de domínio (ex.: `affiliate.approved`,
                      `conversion.created`).
                    example: affiliate.approved
                  version:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Versão do schema do payload deste tipo de evento.
                    example: 1
                  aggregateType:
                    type: string
                    description: >-
                      Tipo do agregado ao qual o evento pertence (ex.:
                      `affiliate`, `conversion`).
                    example: affiliate
                  aggregateId:
                    type: string
                    description: Identificador do agregado afetado (ID com prefixo + ULID).
                    example: aff_01J9Z3K8N2QF4T7B9XP0WMD5RC
                  payload:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                    description: >-
                      Dados específicos do evento; a estrutura varia conforme o
                      `type` e a `version`.
                  metadata:
                    type: object
                    properties:
                      actor:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - user
                              - api_key
                              - system
                            description: Tipo do ator que disparou o evento.
                            example: user
                          id:
                            type: string
                            description: >-
                              Identificador do ator (ID do usuário, da chave de
                              API ou nome do processo de sistema).
                            example: user_01J9Z3K8N2QF4T7B9XP0WMD5RC
                        required:
                          - type
                          - id
                        additionalProperties: false
                        description: Ator responsável pela ação que originou o evento.
                      source:
                        description: >-
                          Origem do evento (ex.: `api`, `webhook` ou o processo
                          automático que o emitiu).
                        example: api
                        type: string
                    required:
                      - actor
                    additionalProperties: false
                    description: Metadados de auditoria do evento (ator e origem).
                  occurredAt:
                    description: Momento em que o fato de negócio ocorreu (ISO-8601).
                    example: '2026-06-13T12:00:00.000Z'
                    type: string
                    format: date-time
                  recordedAt:
                    description: >-
                      Momento em que o evento foi registrado pela plataforma
                      (ISO-8601).
                    example: '2026-06-13T12:00:00.000Z'
                    type: string
                    format: date-time
                required:
                  - id
                  - organizationId
                  - type
                  - version
                  - aggregateType
                  - aggregateId
                  - payload
                  - metadata
                  - occurredAt
                  - recordedAt
                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`.

````