Skip to main content
POST
Confirma fraude (anula a conversão)

Authorizations

Authorization
string
header
required

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

Path Parameters

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

Response

200 - application/json

Default Response

id
string
required

Identificador único da conversão.

Example:

"conv_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização dona da conversão.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

programId
string
required

Programa ao qual a conversão pertence.

Example:

"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"

affiliateId
string
required

Afiliado a quem a conversão foi atribuída.

Example:

"aff_01J9Z3K8N2QF4T7B9XP0WMD5RC"

clickId
string | null
required

Clique vencedor da atribuição (null quando não atribuída por clique).

Example:

"clk_01J9Z3K8N2QF4T7B9XP0WMD5RC"

couponId
string | null
required

Cupom usado na atribuição (null quando não houve cupom).

Example:

"coup_01J9Z3K8N2QF4T7B9XP0WMD5RC"

parentConversionId
string | null
required

Conversão original quando esta é uma recorrência derivada (null na conversão inicial).

Example:

"conv_01J9Z3K8N2QF4T7B9XP0WMD5RC"

type
enum<string>
required

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.

Available options:
subscription_created,
one_time_purchase,
trial_converted,
upgrade,
custom
Example:

"subscription_created"

status
enum<string>
required

Status da conversão. pending: aguardando revisão (ex.: travada por fraude). approved: aprovada e elegível a comissão. voided: anulada (manualmente ou por confirmação de fraude). refunded: estornada após reembolso do cliente.

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

"approved"

amountCents
integer
required

Valor da conversão em centavos. Ex.: 1990 = R$ 19,90.

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

1990

currency
string
required

Moeda da conversão.

Example:

"BRL"

customerId
string
required

Identificador do cliente na loja.

Example:

"cust_8842"

customerEmailHash
string | null
required

Hash SHA-256 do e-mail do cliente (null quando não informado).

productId
string | null
required

Produto vendido (null quando não informado).

Example:

"plan_pro_monthly"

sourceEventId
string
required

Identificador do evento de origem usado na deduplicação.

Example:

"order_2026-0001"

source
enum<string>
required

Origem do registro. api: enviada pela sua integração servidor-a-servidor. manual: criada por um operador. webhook: recebida do seu gateway de pagamento. script: disparada pelo tracker client-side no browser.

Available options:
api,
manual,
webhook,
script
Example:

"api"

matchMethod
enum<string>
required

Método usado para atribuir a conversão a um afiliado. click_id: clique identificado. visitor_id: visitante rastreado. email_hash: hash de e-mail do cliente. fingerprint: impressão digital do dispositivo. coupon: cupom de afiliado. manual: atribuição manual por operador.

Available options:
click_id,
visitor_id,
email_hash,
fingerprint,
coupon,
manual
Example:

"click_id"

commissionSkippedReason
enum<string> | null
required

Motivo de a comissão não ter sido gerada (null quando a comissão foi gerada normalmente).

Available options:
program_paused,
affiliate_paused,
self_referral,
product_not_applicable,
pending_confirmation
Example:

"affiliate_paused"

fraudDecision
enum<string>
required

Decisão antifraude. approve: score abaixo do limite, aprovada automaticamente. monitor: aprovada, porém monitorada. review: travada para revisão manual. cleared: revisão manual concluiu falso positivo. confirmed: fraude confirmada (conversão anulada).

Available options:
approve,
monitor,
review,
cleared,
confirmed
Example:

"approve"

voidReason
string | null
required

Motivo da anulação (null quando a conversão não foi anulada).

Example:

"Reembolso solicitado pelo cliente"

attributionSnapshot
object
required

Snapshot da decisão de atribuição registrada na conversão.

ruleSnapshot
object | null
required

Snapshot da regra de comissão aplicada (null quando nenhuma comissão foi gerada).

fraudSnapshot
object
required

Snapshot da avaliação antifraude registrada na conversão.

occurredAt
string<date-time>
required

Data/hora em que a conversão ocorreu (ISO-8601).

Example:

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

createdAt
string<date-time>
required

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

Example:

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

updatedAt
string<date-time>
required

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

Example:

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