Saltar al contenido principal

Notificación por Webhook (Callback)

Vendis enviará una notificación asíncrona a tu sistema cada vez que un cliente realice el pago de un QR generado. Para ello debes proporcionar a Vendis la URL (Endpoint) de tu sistema.

Especificación de la Notificación​

  • Ruta: <URL_DEL_SISTEMA_INTEGRADOR> (Ej. api/v1/devices/simple-qr/callback)
  • Método: POST
  • Reintentos: El sistema realizará hasta 3 reintentos si tu servidor no responde con un estado de éxito (HTTP 200 OK).

Headers (Opcional)​

Si tu sistema requiere autenticación, Vendis puede enviar un token o encabezado personalizado en la notificación.

  • Ejemplo: Bearer <TOKEN> o X-API-KEY: <TU_CLAVE> (Se sugiere que el webhook cuente con autenticación para mayor seguridad).

Payload (Datos enviados por Vendis)​

El sistema de Vendis enviará un payload JSON con los detalles del pago:

{
  "payment_date": "2023-02-03 09:09:02",
  "payment_amount": "34.00",
  "qr_id": 234234,
  "payment_name": "Carlos Vargas",
  "payment_bank": "Bisa"
}

Respuesta Esperada​

Tu sistema debe responder a la petición confirmando la recepción para detener el ciclo de reintentos de Vendis.

Respuesta de Éxito de tu Sistema​

{
    "success": true,
    "message": "Ok"
}

Respuesta de Error de tu Sistema​

{
    "success": false,
    "message": "Mensaje de error descriptivo"
}