Consulta um lote de payout com seus payouts e notas fiscais
Retorna um lote de fechamento. Use expand=payouts e/ou expand=invoices para incluir os payouts agregados e as notas fiscais vinculadas, e expand=payable para o resumo de repasses pagáveis vs. retidos (a mesma regra da autorização do aporte).
Authorizations
Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....
Path Parameters
Identificador do lote de fechamento (prefixo cyc_ + ULID).
^cyc_[0-9A-HJKMNP-TV-Z]{26}$"cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Query Parameters
Relações a expandir na resposta: payouts, invoices e/ou payable.
payouts, invoices, payable Response
Default Response
Identificador único do lote de fechamento (prefixo cyc_ + ULID).
"cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Organização (tenant) dona do lote.
"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Programa ao qual o fechamento foi restrito. null quando o lote cobriu todos os programas.
"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Status atual do lote.
processing, completed, partial "completed"
Instante do fechamento do ciclo (ISO-8601).
"2026-06-01T03:00:00.000Z"
Quantidade de afiliados elegíveis pagos neste fechamento.
-9007199254740991 <= x <= 900719925474099112
Soma dos valores do fechamento em centavos (ex.: 1990 = R$19,90).
-9007199254740991 <= x <= 9007199254740991482310
Identificadores dos payouts agregados no lote.
Identificadores das notas fiscais vinculadas aos payouts do lote.
Data de criação do lote (ISO-8601).
"2026-06-01T03:00:00.000Z"
Data da última atualização do lote (ISO-8601).
"2026-06-01T03:00:00.000Z"
Payouts do lote (com nome do afiliado, conversões e resumo da NF), quando expand=payouts.
Notas fiscais vinculadas aos payouts do lote, incluídas quando expand=invoices.
Resumo de pagáveis do lote (quem entra na cobrança PIX agora vs. retidos), incluído quando expand=payable. Mesma regra da autorização do aporte.
Aporte (cobrança PIX / QR) do lote. null enquanto o repasse não foi autorizado.