Cria uma comissão de bônus avulsa
Cria uma comissão de bônus avulsa para um afiliado, sem vínculo com conversão (type=bonus). Idempotente via header Idempotency-Key.
Authorizations
Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....
Body
Identificador do afiliado que receberá o bônus.
^aff_[0-9A-HJKMNP-TV-Z]{26}$"aff_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Valor do bônus em centavos (ex.: 5000 = R$50,00). Deve ser positivo.
1 <= x <= 90071992547409915000
Descrição do bônus (motivo/campanha), registrada na memória de cálculo.
1 - 500"Bônus de campanha de junho"
Response
Default Response
Identificador único da comissão (prefixo comm_ + ULID).
"comm_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Identificador da organização (tenant) dona da comissão.
"org_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Identificador do programa de afiliados ao qual a comissão pertence.
"prog_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Identificador do afiliado que recebe a comissão.
"aff_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Identificador da conversão que originou a comissão. null para bônus avulsos.
"conv_01J9Z3K8QXY4M2N6P7R0S1T2V3"
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.
standard, clawback, bonus, adjustment "standard"
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.
pending, approved, paid, voided "pending"
Indica se a comissão está retida em revisão (ex.: afiliado sob suspeita de fraude/ban).
false
Ciclo de cobrança (1-based) para comissões recorrentes. null quando não recorrente.
-9007199254740991 <= x <= 90071992547409911
Valor da comissão em centavos. Pode ser negativo em estornos (clawback).
-9007199254740991 <= x <= 9007199254740991298
Moeda da comissão (ISO 4217).
"BRL"
Memória de cálculo da comissão (regra aplicada, base, percentuais e detalhes específicos do tipo).
Data/hora (ISO-8601) até quando a comissão fica em hold antes de poder ser aprovada.
"2026-07-13T12:00:00.000Z"
Identificador do evento de origem que gerou a comissão.
"evt_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Identificador da comissão original referenciada por um estorno ou ajuste.
"comm_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Motivo informado ao anular a comissão. null quando não anulada.
"Pedido cancelado pelo cliente"
Identificador do payout em que a comissão foi paga. null enquanto não paga.
"pay_01J9Z3K8QXY4M2N6P7R0S1T2V3"
Data/hora (ISO-8601) em que o fato gerador da comissão ocorreu.
"2026-06-13T12:00:00.000Z"
Data/hora (ISO-8601) em que a comissão foi aprovada. null enquanto pendente.
"2026-07-13T12:00:00.000Z"
Data/hora (ISO-8601) de criação do registro.
"2026-06-13T12:00:00.000Z"
Data/hora (ISO-8601) da última atualização do registro.
"2026-06-13T12:00:00.000Z"