Envio de eventos via API (chave de API)
Envio direto de eventos de cobrança para integrações que não usam um gateway com suporte nativo: conversão, cobrança recorrente (ciclos 2 em diante), estorno/chargeback e cancelamento de assinatura. Reenviar o mesmo sourceEventId é tratado como reprocessamento e não duplica o efeito. Autentique com Authorization: Bearer rstr_....
Authorizations
Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....
Body
- Option 1
- Option 2
- Option 3
- Option 4
Tipo da conversão. subscription_created: nova assinatura. one_time_purchase: compra avulsa. trial_converted: trial convertido em assinatura paga. upgrade: upgrade de plano. custom: evento de conversão customizado.
subscription_created, one_time_purchase, trial_converted, upgrade, custom "subscription_created"
Valor da conversão em centavos (inteiro). Ex.: 1990 = R$ 19,90.
0 <= x <= 90071992547409911990
Dados do cliente que originou a conversão.
Identificador único do evento de origem na loja, usado para deduplicação/idempotência permanente.
1 - 255"order_2026-0001"
Tipo do evento: conversion registra uma nova conversão (venda/assinatura) atribuída a um afiliado.
conversion Moeda da conversão. Apenas BRL (Real brasileiro).
BRL Data/hora em que a conversão ocorreu (ISO-8601). Default: momento do recebimento.
"2026-06-13T12:00:00.000Z"
Identificador do produto vendido. Confrontado com applicableProductIds da regra vigente.
1 - 255"plan_pro_monthly"
Programa ao qual a conversão pertence. Obrigatório quando a organização tem mais de um programa.
^prog_[0-9A-HJKMNP-TV-Z]{26}$"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Identificador do clique a ser atribuído (matching por click_id).
^clk_[0-9A-HJKMNP-TV-Z]{26}$"clk_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Identificador do visitante rastreado (matching por visitor_id).
^vis_[0-9A-HJKMNP-TV-Z]{26}$"vis_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Hash SHA-256 do e-mail do cliente, usado no matching por email_hash.
^[a-f0-9]{64}$"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3"
Hash SHA-256 da impressão digital do dispositivo, usado no matching por fingerprint.
^[a-f0-9]{64}$"a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3"
Código de cupom de afiliado utilizado na compra (matching por coupon).
1 - 64"MARIA10"
Google Click Identifier, propagado no snapshot de atribuição.
1 - 255"Cj0KCQiA_gclid_example"
Response
Default Response
Resultado do processamento. processed: evento aplicado com sucesso. replayed: já havia sido processado antes (mesmo sourceEventId reenviado). unmatched: nenhuma conversão correspondente encontrada. skipped: reconhecido, mas não aplicado por não atender a uma regra de negócio. ignored: evento sem relevância de negócio.
processed, replayed, unmatched, skipped, ignored "processed"
Motivo do resultado quando aplicável (ex.: por que foi ignorado ou pulado). null quando processado normalmente.
"unsupported event type"
ID da conversão afetada (prefixo conv_ + ULID). null quando nenhuma conversão foi correspondida.
"conv_01J9Z3K8N2QF4T7B9XP0WMD5RC"
IDs das comissões criadas ou afetadas pelo evento (prefixo comm_ + ULID).