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

# Payout batches

> Lotes de fechamento de ciclo: histórico dos payouts agrupados por rodada.

`repass.payoutBatches` lê os **lotes de fechamento**: cada execução real de ciclo ([`payouts.run`](/docs/sdk/recursos/payouts) com `dryRun: false`) cria um lote que agrupa os payouts daquela rodada. É a base do histórico de "Ciclos" do painel.

O `status` do lote (`processing`, `completed`, `partial`) e as listas `payoutIds`/`invoiceIds` são derivados dos payouts-membro: `processing` enquanto houver payout agendado/em processamento, `completed` quando todos concluem, `partial` quando liquida com falha ou cancelamento.

## Consulta

`retrieve` aceita `expand: ["payouts", "invoices"]` para trazer os payouts agregados e as notas fiscais vinculadas.

```ts theme={null}
// Listar (RepassPage, filtro opcional por programa)
await repass.payoutBatches.list({ program_id: "prog_…" }); // → RepassPage<PayoutBatch>

// Buscar um lote (com payouts e NFs do ciclo)
await repass.payoutBatches.retrieve("cyc_…", {
  expand: ["payouts", "invoices"],
}); // → ExpandedPayoutBatch (PayoutBatch + payouts/invoices quando expandido)
```

<Note>
  Para o schema completo de `PayoutBatch` e dos objetos expandidos, consulte a [Referência da API](/docs/convencoes/ids-e-recursos). As regras de negócio estão em [Payouts](/docs/conceitos/payouts).
</Note>
