Skip to main content
GET
Política de payouts vigente (ciclo, dia de fechamento, mínimo, método)

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

Default Response

cycle
enum<string>
default:monthly
required

Ciclo de fechamento de payouts. monthly: mensal. biweekly: quinzenal. manual: somente sob demanda. O fechamento é sempre disparado manualmente pela API.

Available options:
monthly,
biweekly,
manual
Example:

"monthly"

closingDay
integer
default:1
required

Dia do mês usado como referência de fechamento do ciclo (1 a 28).

Required range: 1 <= x <= 28
Example:

1

minimumPayoutCents
integer
default:5000
required

Valor mínimo em centavos para que um afiliado seja elegível ao payout (ex.: 5000 = R$50,00). Abaixo disso, o afiliado é bloqueado por below_minimum.

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

5000

defaultMethod
enum<string>
default:pix
required

Método de pagamento padrão aplicado quando o afiliado não definiu um.

Available options:
pix
Example:

"pix"

autoRetryFailed
boolean
default:false
required

Quando true, a plataforma reagenda automaticamente (failed → scheduled) payouts falhos com failureCount abaixo de autoRetryLimit. Retry manual continua disponível e não é afetado por esta flag.

Example:

false

autoRetryLimit
integer
default:3
required

Quantidade máxima de tentativas automáticas por payout falho (1 a 5). Retry manual não conta para este limite nem zera o contador.

Required range: 1 <= x <= 5
Example:

3