Skip to main content
POST
Aprova uma comissão antecipadamente (antes do fim do hold) ou libera sua revisão de ban

Authorizations

Authorization
string
header
required

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

Path Parameters

commissionId
string
required
Pattern: ^comm_[0-9A-HJKMNP-TV-Z]{26}$

Response

200 - application/json

Default Response

id
string
required

Identificador único da comissão (prefixo comm_ + ULID).

Example:

"comm_01J9Z3K8QXY4M2N6P7R0S1T2V3"

organizationId
string
required

Identificador da organização (tenant) dona da comissão.

Example:

"org_01J9Z3K8QXY4M2N6P7R0S1T2V3"

programId
string
required

Identificador do programa de afiliados ao qual a comissão pertence.

Example:

"prog_01J9Z3K8QXY4M2N6P7R0S1T2V3"

affiliateId
string
required

Identificador do afiliado que recebe a comissão.

Example:

"aff_01J9Z3K8QXY4M2N6P7R0S1T2V3"

conversionId
string | null
required

Identificador da conversão que originou a comissão. null para bônus avulsos.

Example:

"conv_01J9Z3K8QXY4M2N6P7R0S1T2V3"

type
enum<string>
required

Tipo da comissão. standard: comissão padrão gerada por uma conversão. clawback: estorno (valor negativo) por reembolso/chargeback. bonus: comissão avulsa concedida manualmente. adjustment: ajuste (delta) aplicado a uma comissão já paga quando ela é recalculada.

Available options:
standard,
clawback,
bonus,
adjustment
Example:

"standard"

status
enum<string>
required

Situação da comissão. pending: aguardando o fim do período de hold. approved: liberada e elegível para payout. paid: já incluída em um payout pago. voided: cancelada/anulada.

Available options:
pending,
approved,
paid,
voided
Example:

"pending"

underReview
boolean
required

Indica se a comissão está retida em revisão (ex.: afiliado sob suspeita de fraude/ban).

Example:

false

billingCycle
integer | null
required

Ciclo de cobrança (1-based) para comissões recorrentes. null quando não recorrente.

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

1

amountCents
integer
required

Valor da comissão em centavos. Pode ser negativo em estornos (clawback).

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

298

currency
string
required

Moeda da comissão (ISO 4217).

Example:

"BRL"

calculation
object
required

Memória de cálculo da comissão (regra aplicada, base, percentuais e detalhes específicos do tipo).

holdUntil
string<date-time> | null
required

Data/hora (ISO-8601) até quando a comissão fica em hold antes de poder ser aprovada.

Example:

"2026-07-13T12:00:00.000Z"

sourceEventId
string | null
required

Identificador do evento de origem que gerou a comissão.

Example:

"evt_01J9Z3K8QXY4M2N6P7R0S1T2V3"

originalCommissionId
string | null
required

Identificador da comissão original referenciada por um estorno ou ajuste.

Example:

"comm_01J9Z3K8QXY4M2N6P7R0S1T2V3"

voidReason
string | null
required

Motivo informado ao anular a comissão. null quando não anulada.

Example:

"Pedido cancelado pelo cliente"

payoutId
string | null
required

Identificador do payout em que a comissão foi paga. null enquanto não paga.

Example:

"pay_01J9Z3K8QXY4M2N6P7R0S1T2V3"

occurredAt
string<date-time>
required

Data/hora (ISO-8601) em que o fato gerador da comissão ocorreu.

Example:

"2026-06-13T12:00:00.000Z"

approvedAt
string<date-time> | null
required

Data/hora (ISO-8601) em que a comissão foi aprovada. null enquanto pendente.

Example:

"2026-07-13T12:00:00.000Z"

createdAt
string<date-time>
required

Data/hora (ISO-8601) de criação do registro.

Example:

"2026-06-13T12:00:00.000Z"

updatedAt
string<date-time>
required

Data/hora (ISO-8601) da última atualização do registro.

Example:

"2026-06-13T12:00:00.000Z"