Eventos

Los eventos son nuestra forma de avisar cuando sucede algo interesante en su cuenta. Cuando ocurre un evento, creamos un nuevo objeto evento. Si registró un webhook para recibir ese evento, lo enviamos como parte de una solicitud POST.

Cómo se activan los eventos

Para activar/desactivar las notificaciones de eventos para cualquier ambiente, se debe de ingresar al panel de control (Kashio Manager) del ambiente a conectar con las credenciales (usuario y contraseña) proporsionado al momento de terminar su afiliación con Kashio.

Luego de ingresar, haz click 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 "Gestión de eventos / Eventos" puede activar o desactivar los eventos necesarios para su empresa.

Lista de eventos disponibles

Objeto: Orden de pago (Deuda)

Evento	Descripción
Creado	Deuda creada, cuando la empresa crea la deuda en nuestra plataforma
Pagado	Deuda pagada, cuando institución financiera confirma el pago
Anulado	Deuda anulada, solo la empresa puede anular las deudas por diferentes motivos
Expirado	Deuda expirada, no se puede hacer ningún cambio de estado

Objeto: Liquidación

Evento	Descripción
Creado	Liquidación creada, cuando Kashio crea la orden de liquidación a pagar
Confirmación	Liquidación confirmada, cuando Kashio hace el abono en las cuentas de la empresa

Estructura del objeto evento

Atributo	Tipo de dato	Descripción
event.id	string	Id del evento a notificar
event.object	string	Nombre del object evento
event.livemode	boolean	Si es producción (true) o pruebas (false)
event.created	datetime	Fecha de creación (ISO-8601: yyyy-MM-ddThh:mm:ss)
event.type	string	Tipo de evento a notificar
data.url	string	Ruta de id de la deuda
data.invoice.id	string	Id de la deuda
data.invoice.external_id	string	Id único de cliente en los sistemas de la empresa
data.invoice.currency	string	Moneda de la deuda (ISO-4217 - 3 dígitos)
data.invoice.subtotal	string	Monto subtotal de la orden de pago en 2 decimales
data.invoice.fees	string	Monto de la comisión que el usuario final asumirá en 2 decimales
data.invoice.late_fee	string	Monto de la mora en 2 decimales (de tenerlo configurado)
data.invoice.amount	string	Monto total de la orden de pago en 2 decimales
data.invoice.object	string	Nombre del objeto de los valores enviados
event.status	string	Estado de la notificación del evento
event.message_id	string	Id interno del mensaje enviado por la notificación del evento

Ejemplo de código JSON:

{
  "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"
}