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

# Reenfileira um payout que falhou para reprocessamento

> Reenfileira um payout com status `failed` para reprocessamento, emite o evento correspondente e dispara a execução em seguida (best-effort; o cron diário é a rede de segurança). Exige perfil owner ou admin.



## OpenAPI

````yaml /openapi.json post /payouts/{payoutId}/retry
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}/retry:
    post:
      tags:
        - Payouts
      summary: Reenfileira um payout que falhou para reprocessamento
      description: >-
        Reenfileira um payout com status `failed` para reprocessamento, emite o
        evento correspondente e dispara a execução em seguida (best-effort; o
        cron diário é a rede de segurança). Exige perfil owner ou admin.
      operationId: retryPayout
      parameters:
        - 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
                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`.

````