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
![](https://files.readme.io/7b98645-3.png)
![](https://files.readme.io/76525bc-TXO_API_FLOW_1_1.png)
![](https://files.readme.io/868d788-1.png)
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:
- Nuevo pago
- Cuando cambia el status de un pago.
- Ejemplos:
- Cuando el status de un pago cambia de "pending" a "approved" o "rejected"
- Cuando el status de un pago cambia de "approved" a "cancelled" o "refunded"
- Cuando el status de un pago cambia de "authorized" a "approved"
- Ejemplos:
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.