Confirmation

O que é

O /confirmation é um endpoint que deve ser desenvolvido pelo parceiro que estiver integrando com a Wake e que possibilita a execução de ações críticas após a finalização da compra — como disparo de pixels, validação de dados, ou injeção de scripts HTML personalizados, permitindo que os parceiros recebam e retornem informações específicas para essa etapa da jornada de compra.

❗️

Importante

Esse é um recurso disponível apenas para lojas Storefront 2.0

Fluxo de Funcionamento

Quando o usuário acessa a página de confirmação, é feito uma requisição com método HTTP HEAD para o endpoint /confirmation para verificar se ele foi implementado e, na sequência, a requisição POST é feita para retornar os scripts e hmtl a serem injetados na página;

O parceiro deve retornar um objeto no seguinte formato:

{  
  "html": "<div>...</div>",  
  "scriptUrls": ["https://cdn.partner.com/confirmation.js"]  
}

O Storefront API injeta o HTML e os scripts retornados diretamente na página de confirmação, exibindo as informações ou executando os códigos conforme o retorno do parceiro.

Estrutura Esperada do Endpoint do Parceiro (/confirmation)

O parceiro deve disponibilizar um endpoint que receba as mesmas informações de contexto do /payment-details, e retorne o seguinte payload:

Requisição

POST /confirmation

{  
  "orderId": "123456",  
  "checkoutId": "0fbd2c1f-d28a-4b1f-9f77-6cfd93b9b7de",  
  "amount": 199.90,  
  "paymentMethod": "credit_card",  
  "status": "APPROVED",  
  "customer": {  
    "name": "Maria Silva",  
    "email": "mailto:[email protected]"  
  }  
}

Resposta esperada

{  
  "html": "<div class='partner-confirmation'>Compra aprovada! 🎉</div>",  
  "scriptUrls": [  
    "https://cdn.parceiro.com/confirmation.js"  
  ]  
}

Benefícios

  • Permite que parceiros injetem scripts ou componentes HTML diretamente na tela de confirmação.
  • Facilita coletas de dados pós-compra, como analytics e eventos de tracking.
  • Garante padronização de integração com o Storefront 2.0, reaproveitando a mesma estrutura do /payment-details
  • Reduz necessidade de customizações no frontend das lojas.

Observações Importantes

  • O retorno deve respeitar boas práticas de segurança — o HTML e scripts injetados serão renderizados no contexto do checkout Wake.
  • Caso o endpoint do parceiro não responda, a página continuará carregando normalmente, apenas sem os elementos adicionais.