cred.loan.disbursed

cred.loan.disbursed

Overview

The cred.loan.disbursed webhook event is triggered when the loan amount is disbursed 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, “cred.loan.disbursed”
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.application	Object	Information about the loan application.
payload.application.id	Integer	The unique loan id in JODO system.
payload.application.status	String	The current status of the loan application.
payload.application.amount	Number	The total amount for which the loan is taken.
payload.application.agreement_signed_at	String	The datetime str indicating when the loan agreement was signed.
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.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.disbursement	Object	Information about the loan disbursement.
payload.disbursement.id	Integer	The unique id for the disbursement in JODO system.
payload.disbursement.date	String	The date on which the disbursement was done.
payload.disbursement.disbursed_amount	Number	The disbursed amount.
payload.disbursement.amount	Number	The amount for the tranche.
payload.disbursement.is_disbursed	Boolean	The boolean flag indicating if the disbursement is done.
payload.disbursement.details	Array	An array containing the breakdown of the disbursement details.
payload.disbursement.details[].fee_component	String	The type of fee component (e.g., TUITION_FEE, TRANSPORT_FEE).
payload.disbursement.details[].amount	Number	The amount disbursed for the corresponding fee component.
payload.disbursement.details[].settlement_utr	String	The UTR for the disbursement done for the corresponding fee component.
payload.disbursement.details[].settled_at	String	The datetime str at which the settlement was done.

Example

{
  "event_id": "04c0d935-f98c-40cc-ba2d-24ad19153d95",
  "event": "cred.loan.disbursed",
  "timestamp": 1692009563,
  "version": "1.0",
  "payload": {
    "jodo_student_id": 6536,
    "application": {
      "id": 1053,
      "status": "loan_disbursed",
      "amount": 6200.0,
      "agreement_signed_at": "2023-02-22T11:47:25Z"
    },
    "student": {
      "identifier": "JODO/DISB/001",
      "custom_identifier": null,
      "collector_code": "81c6b473c138",
      "academic_year_start": 2022,
      "academic_year_end": 2023,
      "grade": { "name": "Class I", "code": "fdb97be4" }
    },
    "disbursement": {
      "id": 432,
      "date": "2023-03-03",
      "disbursed_amount": 6200.0,
      "amount": 6200.0,
      "is_disbursed": true,
      "details": [
        {
          "fee_component": "ADMISSION_FEE",
          "amount": 1000.0,
          "settlement_utr": "test_432",
          "settled_at": "2023-03-03"
        },
        {
          "fee_component": "BOARD_FEE",
          "amount": 200.0,
          "settlement_utr": "test_432",
          "settled_at": "2023-03-03"
        },
        {
          "fee_component": "TUITION_FEE",
          "amount": 5000.0,
          "settlement_utr": "test_432",
          "settled_at": "2023-03-03"
        }
      ]
    }
  }
}

Handling the Event

Upon receiving the cred.loan.disbursed event, you can update your systems to record the disbursement details.