Ir al contenido principal

Cómo usar Webhook para verificar el estado del pago

Resumen

Wati proporciona una API para verificar el estado de los pagos y webhooks para realizar un seguimiento de cuándo se envían los mensajes de pedido a los clientes. Esta guía explica cómo recuperar el estado de pago, comprender los valores de estado de pago y mensaje, y habilitar los webhooks en su cuenta de Wati.

Nota: Las funciones de pago se encuentran actualmente en versión Beta privada. Póngase en contacto con el equipo de soporte de Wati para habilitarlas en su cuenta.

Instrucciones

1. Verificar el estado del pago mediante API

Puede utilizar la API de Wati para recuperar el estado de un pago utilizando su ID de referencia.

Endpoint de la API

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

Parámetros de la API

Parámetro

Ubicación

Descripción

tenantId

Ruta

Su ID de inquilino (tenant ID) de Wati.

referenceId

Ruta

El ID de referencia asociado con el pago.

Crear un token de API

Para acceder a la API, cree un token de API en su cuenta de Wati.

  • Vaya a Connector > API.

  • Haga clic en Create API Token.

  • Cree su token para autenticar sus solicitudes de API.

Comprender los valores de estado de pago

La API devuelve un estado que indica el resultado del pago.

Estado

Descripción

captured

El pago se completó correctamente.

failed

El intento de pago no tuvo éxito.

Importante: Para cuentas con varios números de WhatsApp, el estado "Payment Captured" solo está disponible para el número predeterminado. No es compatible con números adicionales conectados.

2. Realizar el seguimiento de los mensajes de pedido mediante webhooks

Wati envía una notificación de webhook cuando un mensaje de pedido se envía correctamente a un cliente. Puede utilizar esta notificación para realizar un seguimiento del estado del mensaje.

Webhook de mensaje enviado

El evento de webhook para un mensaje de pedido enviado correctamente es:

  • Evento: templateMessageSent_v2

  • Estado: SENT

El estado SENT significa que Wati aceptó y envió el mensaje. No confirma que el mensaje haya sido entregado en el dispositivo del destinatario.

Para realizar un seguimiento de la entrega del mensaje o de los fallos, utilice los siguientes eventos de webhook:

  • sentMessageDELIVERED_v2 — Confirma que el mensaje se entregó en el dispositivo del destinatario.

  • templateMessageFailed — Informa sobre fallos en el envío de mensajes.

Ejemplo de carga útil (payload) de webhook

Cuando Wati activa el evento templateMessageSent_v2, la carga útil del webhook puede verse así:

{
"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"
}

La carga útil incluye el tipo de evento, el estado del mensaje, los identificadores del mensaje, los identificadores de la conversación y del ticket, la información del canal de WhatsApp y la marca de tiempo del evento.

3. Habilitar webhooks en Wati

Para recibir notificaciones de webhook para mensajes de pedido, configure su webhook en su cuenta de Wati.

  • Vaya a Connector > Webhooks.

  • Haga clic en Add Webhook.

  • Ingrese su URL de webhook.

  • Establezca el estado del webhook como Enabled.

  • Seleccione los eventos de webhook relevantes que desea recibir.

Una vez configurado, Wati puede enviar notificaciones a su URL de webhook para los eventos seleccionados.

Resumen de puntos clave

  • Utilice la API de estado de pago para verificar si un pago se completó correctamente o falló.

  • Las funciones de pago se encuentran actualmente en versión Beta privada y deben ser habilitadas por el soporte de Wati.

  • El estado "Payment Captured" solo es compatible con el número de WhatsApp predeterminado en cuentas con varios números.

  • Utilice templateMessageSent_v2 para realizar un seguimiento de cuándo Wati envía correctamente un mensaje de pedido.

  • Utilice sentMessageDELIVERED_v2 para confirmar la entrega del mensaje y templateMessageFailed para realizar el seguimiento de fallos en el envío.

  • Habilite los eventos de webhook relevantes en Connector > Webhooks para recibir notificaciones.

¿Ha quedado contestada tu pregunta?