flex.instalment.settled

flex.instalment.settled

Overview

The flex.instalment.settled webhook event is triggered when an instalment amount is settled to the institute’s bank account.

Payload

Attribute	Type	Description
event_id	String	A unique identifier for the webhook event.
event	String	The event type; in this case, “flex.instalment.settled”
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.jodo_student_id	Integer	The ID of the student in the JODO system.
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.subscription	Object	Information about the flex subscription.
payload.subscription.id	Integer	The unique identifier of the flex subscription.
payload.subscription.status	String	The current status of the flex subscription.
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.reference_id	String	The payment reference ID.
payload.payment.initial_due_date	String	The initial due date for the installment.
payload.payment.due_date	String	The due date for which the payment was done.
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	Number	The amount corresponding to a fee component in the payment done.
payload.payment.details[].settlement_utr	String	The UTR for the disbursement done for the corresponding fee component.
payload.payment.details[].settled_at	String	The datetime str at which the settlement was done.

Example

{
  "event_id": "f1b249f8-9a82-470a-a04c-83b5b1dc836a",
  "event": "flex.instalment.settled",
  "timestamp": 1692010031,
  "version": "1.0",
  "payload": {
    "jodo_student_id": 7951,
    "student": {
      "identifier": "STUDENT_IDENTIFIER",
      "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" }
    },
    "subscription": { "id": 2304, "status": "active" },
    "payment": {
      "id": "flex_12616",
      "amount": 1000.0,
      "reference_id": null,
      "initial_due_date": "2023-10-18",
      "due_date": "2023-10-18",
      "paid_at": "2023-08-14T10:46:20Z",
      "details": [
        {
          "fee_component": "ADMISSION_FEE",
          "amount": 1000.0,
          "settlement_utr": "payment_12616",
          "settled_at": "2023-08-14T10:46:20Z"
        }
      ]
    }
  }
}

Handling the Event

Upon receiving the flex.instalment.settled event, you can update your systems accordingly to reflect the settled payment. This webhook empowers you to maintain synchronized records, ensuring seamless data management between Jodo and your integrated environment.