WooshPay Webhooks #

WooshPay utiliza webhooks para notificar a su aplicación cuando se produce un evento en su cuenta. Los webhooks son especialmente útiles para eventos asíncronos, como cuando el banco de un cliente confirma un pago, un cliente impugna un cargo o cuando se cobran pagos de suscripciones. Puede configurar puntos finales de webhook a través de la API para recibir notificaciones sobre eventos.

Pasos para crear y recibir Webhooks #

Puede empezar a recibir notificaciones de eventos en su aplicación siguiendo los pasos de esta sección:

1. Identifique los eventos que desea supervisar y los eventos para analizar.
2. Cree un punto final webhook como un punto final HTTP (URL) en su servidor local.
3. Gestiona las solicitudes de WooshPay analizando cada objeto de evento y devolviendo 2xx códigos de estado de respuesta.
4. Despliega tu punto final de webhook para que sea una URL HTTPS de acceso público.
5. Registre su URL HTTPS de acceso público mediante el objeto webhook.

Cómo crear un punto final webhook #

Crear un endpoint webhook no es diferente de crear cualquier otra página en tu sitio web. Es un endpoint HTTP o HTTPS en tu servidor con una URL. Si todavía estás desarrollando tu endpoint en tu máquina local, puede ser HTTP. Después de que sea accesible al público, debe ser HTTPS.

Paso 1. Identificar los eventos que deben controlarse #

Utilice la guía de referencia de la API para identificar los eventos de Wooshpay y sus objetos de evento que su punto final de webhook necesita analizar.

Segundo paso: Crear un webhook #

Configure un punto final HTTP en su equipo local que pueda aceptar solicitudes de webhook no autenticadas con un método POST.

Solicitar

{
    "url": "https://apitest.wooshpay.com/v1/receives",
    "descripción": "I am description",
    "enabled_events": [
        "payment_intent.created"
        "payment_intent.payment_failed",
        "payment_intent.requires_action",
        "payment_intent.succeeded",
        "payment_intent.canceled",
        "cargo.reembolso.actualizado"
    ],
    "api_version": "1.0.1"
}

Respuesta

{
    "id": "we_1600745739909070848",
    "object": "webhook_endpoint",
    "creado": 1670482499000,
    "descripción": "soy descripción",
    "metadata": null,
    "secreto": "c2tfdGVzdF9kR1Z6ZERwMFpYTjBNVEl6TkRVMjo=",
    "status": "enabled",
    "url": "https://apitest.wooshpay.com/v1/receives",
    "livemode": false,
    "api_version": "1.0.1",
    "enabled_events": [
        "payment_intent.created",
        "payment_intent.payment_failed",
        "payment_intent.requires_action",
        "payment_intent.succeeded",
        "payment_intent.canceled",
        "cargo.reembolso.actualizado"
    ]
}

Paso 3: Gestionar las solicitudes de WooshPay #

Tu endpoint debe estar configurado para leer objetos de eventos para el tipo de notificaciones de eventos que quieras recibir. WooshPay envía eventos a su punto final webhook como parte de una solicitud POST con una carga JSON.

Devolver una respuesta 2xx
Su endpoint debe devolver rápidamente un código de estado correcto (2xx) antes de cualquier lógica compleja que pudiera causar un timeout.

Intentos y reintentos de entrega #

Entender cómo ver los intentos de entrega, registros de eventos, y la lógica de reintento cuando los eventos webhook no son reconocidos.

Lógica de reintento
En modo directo y de prueba, WooshPay intenta entregar sus webhooks durante un máximo de tres días con un back off exponencial, lo que significa que en total entregaremos 18 veces en 72 horas.

Lógica Webhook pendiente
En los modos en vivo y de prueba, WooshPay intentará notificarte por correo electrónico cualquier webhooks fallido si un endpoint no ha respondido con un código de estado HTTP 2xx. El correo electrónico no sólo le indicará la URL que no se ha podido entregar, sino también cuándo dejaremos de entregar los webhooks, así como la mejor forma de ponerse en contacto con nosotros.