Skip to main content
GET
Consulta um lote de payout com seus payouts e notas fiscais

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

batchId
string
required

Identificador do lote de fechamento (prefixo cyc_ + ULID).

Pattern: ^cyc_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC"

Query Parameters

expand
enum<string>[]

Relações a expandir na resposta: payouts, invoices e/ou payable.

Available options:
payouts,
invoices,
payable

Response

200 - application/json

Default Response

id
string
required

Identificador único do lote de fechamento (prefixo cyc_ + ULID).

Example:

"cyc_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização (tenant) dona do lote.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

programId
string | null
required

Programa ao qual o fechamento foi restrito. null quando o lote cobriu todos os programas.

Example:

"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"

status
enum<string>
required

Status atual do lote.

Available options:
processing,
completed,
partial
Example:

"completed"

closingAt
string<date-time>
required

Instante do fechamento do ciclo (ISO-8601).

Example:

"2026-06-01T03:00:00.000Z"

affiliateCount
integer
required

Quantidade de afiliados elegíveis pagos neste fechamento.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

12

totalCents
integer
required

Soma dos valores do fechamento em centavos (ex.: 1990 = R$19,90).

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

482310

payoutIds
string[]
required

Identificadores dos payouts agregados no lote.

Example:
invoiceIds
string[]
required

Identificadores das notas fiscais vinculadas aos payouts do lote.

Example:
createdAt
string<date-time>
required

Data de criação do lote (ISO-8601).

Example:

"2026-06-01T03:00:00.000Z"

updatedAt
string<date-time>
required

Data da última atualização do lote (ISO-8601).

Example:

"2026-06-01T03:00:00.000Z"

payouts
object[]

Payouts do lote (com nome do afiliado, conversões e resumo da NF), quando expand=payouts.

invoices
object[]

Notas fiscais vinculadas aos payouts do lote, incluídas quando expand=invoices.

payable
object

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.

funding
object | null

Aporte (cobrança PIX / QR) do lote. null enquanto o repasse não foi autorizado.