Webhooks
🔙 En esta sección aprenderás cómo configurar webhooks y qué eventos puedes recibir.
1. Configurar un webhook
Un webhook es una llamada web de vuelta que kredito utiliza para notificarte de eventos específicos. Estas llamadas son configuradas desde el dashboard en la sección de Webhooks.
Para agregar un nuevo webhook, presiona el botón de Agregar nuevo webhook e ingresa el URL al que deseas que se te notifique. También deberás seleccionar los eventos de los que requieres aviso.
Una vez que comiences a recibir notificaciones, podrás visualizarlas en una tabla dando click al webhook correspondiente.
2. Eventos disponibles para webhook
Actualmente, contamos con los siguientes eventos:
- Orden creada.
- Orden aprobada.
- Orden rechazada.
- Orden confirmada.
- Orden en proceso.
- Orden completada.
- Cargo exitoso.
- Cargo denegado.
3. Notificaciones
Es posible visualizar el detalle de los datos enviados en cada notificación dando click en la notificación que requieras.
Este es un ejemplo de la carga de información contenida en un webhook cuando la orden ha sido completada:
{
"event": "order.completed",
"data": {
"order": {
"uuid": "ord-30b8e315d8b442a1b3a43216a13fbb0a",
"reference": "301117",
"subtotal": 970,
"fee": 30,
"total": 1000,
"currency": "MXN",
"status": "completed",
"internal_status": "in_progress",
"expires_at": "2020-07-30T22:48:18.000Z",
"down_payment": 350,
"opening_fee": 50,
"credit": 700,
"apr": 20,
"payment_type": "financing",
"created_at": "2020-07-30T18:48:18.000Z",
"installment": {
"id": "monthly_three",
"name": "3 pagos mensuales",
"months": 3,
"quantity": 3,
"days": 30,
"apr": 20
},
"redirect_url": "https://sandbox-checkout.kredito.io/ord-30b8e315d8b442a1b3a43216a13fbb0a/inicio",
"merchant": {
"uuid": "mch-20f0a9f3cbfc492dbe4a5df3546a918d",
"name": "Kredito"
},
"customer": {
"uuid": "20c9c610-ae81-11ea-bd6d-d9a4c3b2bc97",
"name": "Juan",
"first_surname": "Perez",
"second_surname": "Perez",
"email": "juan.perez@gmail.com",
"phone_number": "3333983434",
"stp": "646180222297986578",
"rfc": "JUPE192939",
"address": {
"street": "Calle 100",
"district": "Colonia",
"town": "Guadalajara",
"city": "Guadalajara",
"state": "JAL",
"zip_code": 45027
}
},
"success_url": "https://domain.com/success",
"failure_url": "https://domain.com/fail",
"items": [],
"charges": [
{
"comment": "Pago inicial",
"installment": 350,
"capital": 350,
"interest": 0,
"tax": 0,
"remain": 700,
"due_date": "2020-07-30",
"uuid": "ch-c475b7dcfeb34371a0f3864b4125aa95",
"currency": "MXN",
"pay_date": "2020-07-30T19:15:20.000Z",
"status": "successful",
"tracking_key": "12345"
},
{
"comment": "Parcialidad 1",
"installment": 287.47,
"capital": 233.33,
"interest": 54.14,
"tax": 7.47,
"remain": 466.67,
"due_date": "2020-09-01",
"uuid": "ch-79c2e858b4ef4843afc0c433fe266f71",
"currency": "MXN",
"pay_date": null,
"status": "pending",
"tracking_key": null
},
{
"comment": "Parcialidad 2",
"installment": 287.47,
"capital": 233.33,
"interest": 54.14,
"tax": 7.47,
"remain": 233.34,
"due_date": "2020-10-01",
"uuid": "ch-be044d1409ee48278d81859697ebe7e0",
"currency": "MXN",
"pay_date": null,
"status": "pending",
"tracking_key": null
},
{
"comment": "Parcialidad 3",
"installment": 287.47,
"capital": 233.33,
"interest": 54.14,
"tax": 7.47,
"remain": 0.01,
"due_date": "2020-11-01",
"uuid": "ch-c8f5bb1a111043a08938c5c999b56b47",
"currency": "MXN",
"pay_date": null,
"status": "pending",
"tracking_key": null
}
]
}
}
}