API Reference

Webhook Endpoints

Recibe las notificaciones de los eventos disponibles

/Un webhook es una notificación del servidor de Kashio hacia el servidor web de le empresa a través de un endpoint URL.

Puede configurar el webhook de su empresa en el panel de control (Kashio Manager) para recibir las notificaciones en línea sobre una variedad de eventos disponibles para tu negocio.

Como registro un Webhook

Para registrar el webhook para cualquier ambiente, se debe de ingresar al panel de control (Kashio Manager) del ambiente deseado con las credenciales (usuario y contraseña) proporsionado al momento de terminar su afiliación con Kashio.

El tipo de autorización es "Basic Authorization" y también de ser necesario dar acceso a las IPs de Kashio para brindar el acceso respectivo si la empresa requiere bloquear IPs.

Luego de ingresar, haz clic en la sección “Configuración / General" de la barra de navegación a la mano izquierda. En ella encontrarás varias secciones, ir a la seccion "Integraciones / Webhook" y completar la información correspondiente.

Webhook

Ejemplo de Notificación

Ejemplo de evento de notificación de pago.

{
  "id": "eve_cert_XXXXXXXXXXX",
  "object": "event",
  "livemode": false,
  "created": "2023-01-02 19:55:30",
  "type": "invoice.paid",
  "data": {
    "url": "//invoices/inv_cert_XXXXXXXXXXXXXX",
    "invoice": {
      "id": "inv_cert_XXXXXXXXXXXXXX",
      "external_id": "1672688695",
      "currency": "PEN",
      "sub_total": "2.01",
      "fees": "0.0",
      "late_fee": "0.0",
      "amount": "2.01",
      "object": "invoice"
    }
  },
  "status": "new",
  "message_id": "5b614527-XXXXXXXX-XXXXXXXXX"
}

Confirmación de Notificación

Como parte del cierre de ciclo de pago, el paso final es que la empresa debe confirmar la recepción del pago en su plataforma.

🚧

La empresa debe confirmar la recepción de la notificación con respuesta de HTTP 200, caso contrario Kashio volverá a reintentar la notificación hasta 10 veces.

Uso de Webhook

Puede usar webhooks para:

  • Actualizar el estado de una orden de pago e identificar si fue pagada.
  • Actualizar la información de un cliente en su plataforma u ERP.
  • Enviar correos, sms o whatsapp a tus clientes informando algun evento relacionado a su compra.
  • Entre otros.