Resumo

O Wati fornece uma API para verificar o status de pagamentos e webhooks para rastrear quando mensagens de pedidos são enviadas aos clientes. Este guia explica como recuperar o status de pagamento, entender os valores de status de pagamento e de mensagem, e ativar webhooks em sua conta Wati.

Nota: Os recursos de pagamento estão atualmente em Beta Privado. Entre em contato com o Suporte Wati para habilitá-los em sua conta.

Instruções

1. Verificar status de pagamento via API

Você pode usar a API do Wati para recuperar o status de um pagamento usando seu ID de referência.

Endpoint da API

GET https://live-mt-server.wati.io/{tenantId}/api/v1/payment_status/{referenceId}

Parâmetros da API

Parâmetro	Local	Descrição
`tenantId`	Caminho	Seu ID de tenant do Wati.
`referenceId`	Caminho	O ID de referência associado ao pagamento.

Criar um Token de API

Para acessar a API, crie um token de API em sua conta Wati.

Vá para Connector > API.
Clique em Create API Token.
Crie seu token para autenticar suas solicitações de API.

Entender os valores de status de pagamento

A API retorna um status indicando o resultado do pagamento.

Status	Descrição
`captured`	O pagamento foi concluído com sucesso.
`failed`	A tentativa de pagamento não teve sucesso.

Importante: Para contas com múltiplos números de WhatsApp, o status "Payment Captured" (Pagamento Capturado) está disponível apenas para o número padrão. Ele não é suportado para números adicionais conectados.

2. Rastrear mensagens de pedidos usando Webhooks

O Wati envia uma notificação via webhook quando uma mensagem de pedido é enviada com sucesso para um cliente. Você pode usar essa notificação para rastrear o status da mensagem.

Webhook de mensagem enviada

O evento de webhook para uma mensagem de pedido enviada com sucesso é:

Evento: templateMessageSent_v2
Status: SENT

O status SENT significa que o Wati aceitou e enviou a mensagem. Isso não confirma que a mensagem foi entregue no dispositivo do destinatário.

Para rastrear a entrega ou falha da mensagem, use os seguintes eventos de webhook:

sentMessageDELIVERED_v2 — Confirma que a mensagem foi entregue no dispositivo do destinatário.
templateMessageFailed — Reporta falhas no envio de mensagens.

Exemplo de payload de Webhook

Quando o Wati aciona o evento templateMessageSent_v2, o payload do webhook pode ter esta aparência:

{
  "eventType": "templateMessageSent_v2",
  "statusString": "SENT",
  "localMessageId": "d38f0c3a-e833-4725-a894-53a2b1dc1af6",
  "whatsappMessageId": "wamid.HBgNODEYEjQ3RDMzQzM2QjM3QjU1ODQ4RQA=",
  "conversationId": "68b68470e93cc",
  "ticketId": "693fd6ab545f82",
  "type": "template",
  "channelId": null,
  "channelPhoneNumber": "85264318722",
  "timestamp": "1667211460"
}

O payload inclui o tipo de evento, status da mensagem, identificadores da mensagem, identificadores de conversa e ticket, informações do canal do WhatsApp e o carimbo de data/hora do evento.

3. Ativar Webhooks no Wati

Para receber notificações de webhook para mensagens de pedidos, configure seu webhook em sua conta Wati.

Vá para Connector > Webhooks.
Clique em Add Webhook.

Insira a URL do seu webhook.
Defina o status do webhook como Enabled (Ativado).
Selecione os eventos de webhook relevantes que você deseja receber.

Uma vez configurado, o Wati pode enviar notificações para a URL do seu webhook para os eventos selecionados.

Resumo dos pontos principais

Use a API de status de pagamento para verificar se um pagamento foi concluído com sucesso ou falhou.
Os recursos de pagamento estão atualmente em Beta Privado e devem ser habilitados pelo Suporte Wati.
O status "Payment Captured" é suportado apenas para o número do WhatsApp padrão em contas com múltiplos números.
Use templateMessageSent_v2 para rastrear quando o Wati envia com sucesso uma mensagem de pedido.
Use sentMessageDELIVERED_v2 para confirmar a entrega da mensagem e templateMessageFailed para rastrear falhas de envio.
Ative os eventos de webhook relevantes em Connector > Webhooks para receber notificações.

Como usar Webhook para verificar o Status de Pagamento