Webhook

Notificaciones Webhook

Si se deseas recibir notificaciones webhook en tiempo real, es necesario tomar en cuenta las siguientes consideraciones:

  • Contar con un servicio para escuchar Webhook notification del comercio
  • Realizar una llamada a el endpoint GET /payments/{payment_id} de Clip

Flujo








































Configuración

Para recibir las webhook notifications, es necesario compartir la Webhook URL cuando se consume el servicio POST /payments bajo el siguiente parámetro:

{
"webhook_url": "https://us1.make.com/64555/hooks/129782/queue/a1cb5be30d510dee6111e2386ceab85f"
}

Recibirás notificaciones de los siguientes eventos:

  1. Nuevo pago
  2. Cuando cambia el status de un pago.
    1. Ejemplos:
      1. Cuando el status de un pago cambia de "pending" a "approved" o "rejected"
      2. Cuando el status de un pago cambia de "approved" a "cancelled" o "refunded"
      3. Cuando el status de un pago cambia de "authorized" a "approved"

La estructura de las notificaciones webhook es la siguiente:

Parámetro

Descripción

Tipo

Ejemplo

Notas

id

id del pago.

String

1960c5eb-d9ed-4a55-8d65-a377b5

UUID v4

origin

Origen del pago.

String

"payments-api"

En este caso siempre se mostrará "payments-api".

event_type

Qué tipo de acción se realizó.

String

"INSERT"

Posibles valores: "INSERT" cuando es un nuevo pago, y "UPDATE" cuando se actualiza el status de un pago.


El mensaje dentro de la notificación webhook que recibirás se verá de la siguiente manera:

{
  "id": "cfd8760c-9eae-47dc-8a83-ec643bb39034",
  "origin": "payments-api",
  "event_type": "INSERT"
}


Donde el parámetro “id” corresponde a ID del pago o Payment_id. Dicho valor de ID de pago debe ser consultado con la API de GET /Payments/{payment_id}.

Estarás recibiendo notificaciones webhook cuando se intente un pago, sin importar si es declinado, rechazado, pagado u otro estatus de pago.