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

# Autoriza o repasse de um lote e gera a cobrança PIX (aporte)

> Autoriza o repasse do lote (ação do gestor): calcula o total dos repasses pagáveis (NF validada quando exigida e chave PIX definida), soma a folga de taxas e gera uma cobrança PIX (QR Code) na conta da organização nesse valor. Ao pagar o QR, o saldo é confirmado e a distribuição por PIX é liberada. Requer papel owner/admin. Bloqueado quando a flag PostHog `asaas-payouts` está off.



## OpenAPI

````yaml /openapi.json post /payout-batches/{batchId}/authorize
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:
  /payout-batches/{batchId}/authorize:
    post:
      tags:
        - Payouts
      summary: Autoriza o repasse de um lote e gera a cobrança PIX (aporte)
      description: >-
        Autoriza o repasse do lote (ação do gestor): calcula o total dos
        repasses pagáveis (NF validada quando exigida e chave PIX definida),
        soma a folga de taxas e gera uma cobrança PIX (QR Code) na conta da
        organização nesse valor. Ao pagar o QR, o saldo é confirmado e a
        distribuição por PIX é liberada. Requer papel owner/admin. Bloqueado
        quando a flag PostHog `asaas-payouts` está off.
      operationId: authorizePayoutBatch
      parameters:
        - schema:
            type: string
            pattern: ^cyc_[0-9A-HJKMNP-TV-Z]{26}$
            example: cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC
          in: path
          name: batchId
          required: true
          description: Identificador do lote de fechamento (prefixo `cyc_` + ULID).
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  funding:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Identificador do aporte (prefixo `fund_` + ULID).
                        example: fund_01J9Z3K8N2QF4T7B9XP0WMD5RC
                      batchId:
                        type: string
                        pattern: ^cyc_[0-9A-HJKMNP-TV-Z]{26}$
                        description: Lote de fechamento do aporte.
                      status:
                        type: string
                        enum:
                          - pending
                          - received
                          - expired
                          - canceled
                        description: >-
                          Status do aporte (funding) do lote. `pending`: QR
                          gerado, aguardando pagamento. `received`: pago, saldo
                          confirmado (distribuição liberada). `expired`: QR
                          venceu sem pagamento. `canceled`: cancelado antes de
                          pagar.
                        example: pending
                      payoutTotalCents:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: >-
                          Total dos repasses pagáveis do lote no momento da
                          autorização, em centavos.
                        example: 25000
                      feeBufferCents:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: >-
                          Folga somada ao total para cobrir as taxas do
                          provedor, em centavos.
                        example: 0
                      chargeValueCents:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: >-
                          Valor da cobrança que o gestor paga (total + folga),
                          em centavos.
                        example: 25000
                      receivedNetCents:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                        description: >-
                          Valor líquido creditado na subconta ao pagar (do
                          PAYMENT_RECEIVED).
                      qrPayload:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Copia-e-cola do QR Code PIX (BR Code).
                      qrEncodedImage:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Imagem do QR Code em base64.
                      qrExpiresAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                        description: Expiração do QR Code.
                      requestedAt:
                        type: string
                        format: date-time
                      receivedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - batchId
                      - status
                      - payoutTotalCents
                      - feeBufferCents
                      - chargeValueCents
                      - receivedNetCents
                      - qrPayload
                      - qrEncodedImage
                      - qrExpiresAt
                      - requestedAt
                      - receivedAt
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - funding
                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`.

````