Cria um cupom para um afiliado (sincronizado com o provedor de pagamento)
Cria um cupom de desconto para o afiliado e dispara a sincronização com o provedor de pagamento. O cupom nasce com status pending e passa a active (ou sync_failed) conforme o resultado da sincronização.
Authorizations
Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....
Path Parameters
^aff_[0-9A-HJKMNP-TV-Z]{26}$Body
- Option 1
- Option 2
Código do cupom (3 a 50 caracteres: letras, números e hífens). É normalizado para maiúsculas.
^[A-Z0-9-]{3,50}$"MARIA15"
Desconto percentual sobre o valor da compra.
percentage Percentual de desconto (0,01 a 100, com até 2 casas decimais). Ex.: 15 = 15% de desconto.
0.01 <= x <= 100Must be a multiple of 0.0115
Response
Default Response
Identificador único do cupom (prefixo coup_).
"coup_01J9ZQ8H6K3M2N4P5R6S7T8U9V"
Organização dona do cupom.
"org_01J9ZQ8H6K3M2N4P5R6S7T8U9V"
Programa ao qual o cupom pertence.
"prog_01J9ZQ8H6K3M2N4P5R6S7T8U9V"
Afiliado dono do cupom.
"aff_01J9ZQ8H6K3M2N4P5R6S7T8U9V"
Código do cupom, normalizado em maiúsculas.
"MARIA15"
Tipo de desconto. percentage: percentual sobre a compra. fixed: valor fixo em centavos.
percentage, fixed "percentage"
Valor do desconto. Para percentage, é o percentual (ex.: 15 = 15%). Para fixed, é o valor fixo em centavos (ex.: 1990 = R$19,90).
15
Status do cupom. pending: criado, aguardando sincronização com o provedor de pagamento. active: sincronizado e válido para uso. sync_failed: a sincronização com o provedor de pagamento falhou (tente novamente com a operação de ressincronização). inactive: desativado, não gera mais descontos.
pending, active, sync_failed, inactive "active"
Status da sincronização com o provedor de pagamento. null enquanto a sincronização ainda não foi tentada.
Data/hora em que o cupom foi desativado. null se estiver ativo.
"2026-06-13T12:00:00.000Z"
Data/hora de criação do cupom (ISO-8601).
"2026-06-13T12:00:00.000Z"
Data/hora da última atualização do cupom (ISO-8601).
"2026-06-13T12:00:00.000Z"