Entenda o produto
A jornada de um cupom
Entenda as etapas da API do Cupom, da elegibilidade e cotação ao resgate, pagamento e estorno.
Nesta página
A integração separa descoberta, cálculo e efetivação. Essa divisão permite exibir ofertas sem consumir limites, reservar um desconto durante o checkout e registrar o resultado comercial apenas quando a compra avança.
1. Consultar elegibilidade
A aplicação envia o contexto conhecido e recebe cupons compatíveis. Essa consulta não altera o estado da operação e pode ser usada para apresentar ofertas públicas disponíveis.
2. Criar uma cotação
Ao escolher um código, a aplicação solicita o cálculo. A API avalia produtos, frete, regras, limites e budget, devolvendo os valores e uma cotação temporária.
3. Confirmar o resgate
Quando a compra avançar, confirme o uso do cupom. O resgate é registrado de forma auditável e protegido contra concorrência e duplicidade.
4. Associar o pagamento
O pagamento pode ser informado junto do resgate ou posteriormente, conforme a jornada do checkout. A API registra a situação comercial sem receber dados sensíveis de cartão.
5. Consultar ou reverter
A operação pode ser consultada por identificador interno ou referência do pedido. Quando necessário, cancelamento, estorno integral ou estorno parcial preservam o histórico em vez de apagar o resgate original.