Skip to main content
O grupo payouts gerencia os ciclos de payout, agregando comissões aprovadas em pagamentos por afiliado, com prévia, execução, retentativa e recibos. Lotes de fechamento (payout-batches) ficam em outra página.

​
Consulta

payouts list é paginado. Veja Paginação para --all e cursores.

​
Prévia e execução

preview e run têm efeito pesado sobre o ciclo: ambos são sensitive.
repass payouts preview --json
payouts preview é sensitive mesmo não escrevendo nada: ele roda a mesma simulação pesada usada pelo fechamento (elegibilidade, bloqueios e totais) sobre dados de produção. Em terminal interativo pede confirmação; fora de TTY exige --yes (veja Convenções).
payouts run é dry-run por padrão: sem --live, ele simula o fechamento sem agendar nada de verdade, igual a preview. Só use --live depois de revisar o dry-run com o usuário:
payouts run é sensitive: sem --live é sempre dry-run (seguro de repetir); com --live agenda payouts de verdade. Rode payouts preview (ou payouts run sem --live) primeiro, mostre o resultado ao usuário e só use --live com aprovação explícita. Em terminal interativo pede confirmação; fora de TTY exige --yes (veja Convenções).

​
Relatório contábil

accounting-report retorna a visão contábil dos payouts liquidados num período (por data de pagamento). --from/--to são obrigatórios.

​
Retentativa, cancelamento e recibos

payouts cancel é destructive. As comissões voltam a um estado anterior, mas o payout em si não “renasce”. Rode payouts get pay_xxx antes para ver status/valor. Em terminal interativo pede confirmação; fora de TTY exige --yes (veja Convenções).
Para o schema completo de cada corpo (filtros do ciclo, formato de totals, status e métodos) e os campos de cada objeto retornado, consulte a página SDK equivalente (Payouts) e a Referência da API. As regras de negócio estão em Payouts. Lotes de fechamento ficam em payout-batches.