¿Cómo configurar notificaciones a través de un webhook?

Podrás configurar un Webhook tanto en el ambiente de pruebas (Sandbox) https://sandbox-dashboard.openpay.mx/login, como en el ambiente de producción (Dashboard) https://dashboard.openpay.mx.

Para configurar un Webhook deberás realizar los siguientes pasos:

  1. Ingresa a la plataforma correspondiente al ambiente que desees configurar, pruebas (Sandbox) o producción (Dashboard).
  2. En la parte superior derecha, da clic en el “engrane” y después en “configuraciones”.
  3. En la sección de Webhooks, selecciona la opción “+Agregar”.
  4. En el formulario que aparece, indica la URL completa de tu Webhook, incluyendo el protocolo a usar. Asegúrate que sea https.
  5. Si tu Webhook requiere autenticación HTTP, configúrala. Actualmente solo se soporta autenticación HTTP Basic.
  6. Selecciona todos los eventos que deseas que te sean notificados.
  7. Da clic en el botón de guardar.

Al terminar la configuración de registro, Openpay enviará mediante POST un mensaje JSON a la URL indicada, conteniendo un objeto de notificación Webhook. Tu servicio deberá guardar el código de verificación de alguna manera, y regresar el estado “200 OK”.

Si por alguna razón requieres que se te envíe de nuevo el código de verificación, selecciona la opción Reenviar Código. Un nuevo código de verificación será generado y enviado a la URL proporcionada.

Una vez que ya tengas el código de verificación del Webhook, selecciona la opción de “Verificar” e introduce el código proporcionado en el objeto de la notificación. Esto activará el Webhook en Openpay y empezarás a recibir notificaciones de las transacciones realizadas a partir de ese momento.

Ejemplo:

{
    "type" : "verification",
    "event_date" : "2013-11-22T11:04:49-06:00",
    "verification_code" : "UY1qqrxw"
}

Implementación:

  • Para implementar tu Webhook, solo tienes que crear un servicio Web con una URL a la que Openpay pueda enviar peticiones POST.
  • Tu Webhook debe manejar los diferentes tipos de notificaciones, incluyendo recibir el código de verificación, para que puedas darlo de alta en Openpay.
  • Tu Webhook también deberá poder recibir tipos de notificaciones inesperadas, para asegurar compatibilidad con futuras versiones.
  • Los Webhook deberán regresar un estado HTTP 200 OK siempre que reciban una notificación, de otra manera Openpay reintentará el envío continuamente.

Consulta mayor detalle en https://www.openpay.mx/docs/webhooks.html.

¿Te ha resultado útil esta información?
¿Cómo podemos mejorar esta información?
Artículos Relacionados

Categorías