cred.loan.agreement_signed

cred.loan.agreement_signed

Overview

The cred.loan.agreement_signed webhook event is triggered when the user signs the loan agreement. This event confirms that the user has completed the Cred process and has taken a loan.

Payload

Attribute	Type	Description
event_id	String	A unique identifier for the webhook event.
event	String	The event type; in this case, “cred.loan.agreement_signed”
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.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.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.disbursements	Array	Information about the disbursements.
payload.disbursements[].id	Integer	The unique id for the disbursement in JODO system.
payload.disbursements[].date	String	The date of disbursal for the tranche.
payload.disbursements[].amount	Number	The amount for the tranche.
payload.disbursements[].is_disbursed	Boolean	The boolean flag indicating if the disbursement is done.
payload.disbursements[].settlement_utr	String	The UTR for the disbursement done for the corresponding fee component.
payload.disbursements[].details	Array	The details breakdown of the disbursement at the fee component level.
payload.disbursements[].details[].fee_component	String	The type of fee component (e.g., TUITION_FEE, TRANSPORT_FEE).
payload.disbursements[].details[].amount	Number	The amount corresponding to a fee component for the disbursement.
payload.disbursements[].details[].settlement_utr	String	The UTR for the disbursement done for the corresponding fee component.
payload.disbursements[].details[].settled_at	String	The datetime str at which the settlement was done.
payload.payment_schedule	Array	Instalment details.
payload.payment_schedule[].due_date	String	The due date of an installment in the payment schedule of the student.
payload.payment_schedule[].amount	Number	Instalment amount.

Example

{
  "event_id": "0fa9d373-5822-4507-9ea8-ac4242bcc2da",
  "event": "cred.loan.agreement_signed",
  "timestamp": 1692009458,
  "version": "1.0",
  "payload": {
    "jodo_student_id": 7524,
    "student": {
      "identifier": "Hari_Test",
      "custom_identifier": null,
      "collector_code": "81c6b473c138",
      "academic_year_start": 2022,
      "academic_year_end": 2023,
      "grade": { "name": "Class I", "code": "fdb97be4" }
    },
    "application": {
      "id": 1335,
      "status": "agreement_signed",
      "amount": 1000.0,
      "agreement_signed_at": "2023-06-15T11:37:51Z"
    },
    "disbursements": [
      {
        "id": 468,
        "date": "2023-06-15",
        "amount": 1000.0,
        "is_disbursed": false,
        "settlement_utr": null,
        "details": [
          {
            "fee_component": "ADMISSION_FEE",
            "amount": 1000.0,
            "settlement_utr": null,
            "settled_at": null
          }
        ]
      }
    ],
    "payment_schedule": [
      { "due_date": "2023-07-03", "amount": 111.0 },
      { "due_date": "2023-08-03", "amount": 111.0 },
      { "due_date": "2023-09-03", "amount": 111.0 },
      { "due_date": "2023-10-03", "amount": 111.0 },
      { "due_date": "2023-11-03", "amount": 111.0 },
      { "due_date": "2023-12-03", "amount": 111.0 },
      { "due_date": "2024-01-03", "amount": 111.0 },
      { "due_date": "2024-02-03", "amount": 111.0 },
      { "due_date": "2024-03-03", "amount": 112.0 }
    ]
  }
}

Handling the Event

Upon receiving the cred.loan.agreement_signed event, you can update your systems to indicate that the student has completed the process for a loan with Jodo. For example, course materials can be made available to the student after the loan agreement is signed.