Guias
Conclua e acompanhe a operação
Confirme o resgate do cupom, registre o pagamento, consulte a operação e execute cancelamentos ou estornos.
Nesta página
Depois da cotação, a integração confirma o uso do cupom na etapa em que a compra realmente avançar. A API preserva pedido, carrinho, valores e revisão da regra utilizada.
Confirme o resgate
Use POST /v1/coupon/redeem/single ou POST /v1/coupon/redeem/multiple. Envie uma referência estável de pedido e mantenha o contexto coerente com a compra.
Repetições da mesma intenção devem conservar os mesmos identificadores. Não gere uma nova referência a cada tentativa de rede ou timeout.
Registre o pagamento
Quando o pagamento ocorrer depois do resgate, use POST /v1/coupon/operations/{operation_id}/payments. Registre somente os dados comerciais aceitos pelo contrato; dados de cartão não pertencem ao Cupom.
Consulte a operação
Use o identificador interno em GET /v1/coupon/operations/{operation_id} ou a busca pela referência do pedido. A consulta permite reconciliar o estado após timeout sem repetir comandos às cegas.
Reverta quando necessário
O refund integral classifica a reversão conforme a existência de pagamento. Estornos parciais informam resgates, itens, quantidades e valores permitidos pelo contrato.