direct.payment.cancelled

direct.payment.cancelled

Overview

The direct.payment.cancelled webhook event is triggered when a manual (direct) payment is cancelled in the Jodo system.

Payload

Attribute	Type	Description
event_id	String	A unique identifier for the webhook event.
event	String	The event type; in this case, “direct.payment.cancelled”
timestamp	Integer	The Unix timestamp when the event was originated.
version	String	The version of the webhook payload format (here, “1.0”).
payload	Object	Detailed information about the event.
payload.payment	Object	The payment information.
payload.payment.id	String	The unique payment id in the JODO system.
payload.payment.amount	Number	The payment amount.
payload.payment.mode	String	The mode of payment.
payload.payment.transaction_id	String	The transaction ID for the payment.
payload.payment.settlement_utr	String	The UTR for the disbursement done for the corresponding fee component.
payload.payment.notes	String	The notes containing any additional details for the payment.
payload.payment.paid_at	String	The datetime str indicating at what time the payment was done.
payload.payment.details	Array	The fee component level breakdown of the payment.
payload.payment.details[].fee_component	String	The type of fee component (e.g., TUITION_FEE, TRANSPORT_FEE).
payload.payment.details[].amount	String	The amount corresponding to a fee component in the payment done.
payload.student	Object	Information about the student.
payload.student.identifier	String	The student’s identifier within your system (if applicable).
payload.student.custom_identifier	String	A custom identifier associated with the student.
payload.student.collector_code	String	Branch code (if applicable).
payload.student.academic_year_start	Integer	The start year of the student’s academic year.
payload.student.academic_year_end	Integer	The end year of the student’s academic year.
payload.student.primary_contact_number	String	The primary contact number of the student’s parent or guardian.
payload.student.primary_contact_email	String	The primary contact email address of the student’s parent or guardian.
payload.student.grade	Object	Information about the student’s grade.
payload.student.grade.name	String	The name of the grade (e.g., “Montessori 1”).
payload.student.grade.code	String	The code representing the grade (e.g., “M1BLUE”).
payload.jodo_student_id	Integer	The ID of the student in the JODO system.

Example

{
  "event_id": "9c7ae52e-dad6-4dff-948e-cdfc2926cf7b",
  "event": "direct.payment.cancelled",
  "timestamp": 1692012157,
  "version": "1.0",
  "payload": {
    "payment": {
      "id": "direct_3257",
      "amount": 5000.0,
      "mode": "cash",
      "transaction_id": "tra_1234_Rarome1",
      "settlement_utr": "settl_1234_Rarome1",
      "notes": "advance payment",
      "paid_at": "2022-01-29T10:05:45Z",
      "details": [
        { "fee_component": "ADMISSION_FEE", "amount": "3000.00" },
        { "fee_component": "TUITION_FEE", "amount": "2000.00" }
      ]
    },
    "student": {
      "identifier": "JODO/TEST/005",
      "custom_identifier": null,
      "collector_code": "81c6b473c138",
      "academic_year_start": 2022,
      "academic_year_end": 2023,
      "primary_contact_number": "9876543210",
      "primary_contact_email": "customer@example.com",
      "grade": { "name": "Class I", "code": "fdb97be4" }
    },
    "jodo_student_id": 7268
  }
}

Handling the Event

Upon receiving the direct.payment.cancelled event, you can update your ERP system to reverse the payment record.