order.payment.settled

order.payment.settled

Overview

The order.payment.settled webhook event is triggered when the order 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, “order.payment.settled”
version	String	The version of the webhook payload format (here, “1.0”).
timestamp	Integer	The Unix timestamp when the event was originated.
payload	Object	Detailed information about the event.
payload.order_id	String	The unique order id in JODO system.
payload.order	Object	The information about the order.
payload.order.name	String	The name of the parent.
payload.order.phone	String	The phone number of the parent.
payload.order.identifier	String	The identifier for the order.
payload.order.email	String	The email of the parent.
payload.order.paid_at	String	The datetime str indicating at what time the payment was done.
payload.order.status	String	The current status of the payment order.
payload.order.details	Array	The fee component breakdown of the order.
payload.order.details[].component_type	String	The type of fee component (e.g., TUITION_FEE, TRANSPORT_FEE).
payload.order.details[].amount	Number	The amount corresponding to the fee component.
payload.order.details[].settlement_utr	String	The UTR for the disbursement done for the corresponding fee component.
payload.order.details[].settled_at	String	The datetime str at which the settlement was done.
payload.order.notes	Array	List of key value pairs passed during the creation of order.

Example

{
  "event_id": "952aae99-d4f8-481c-9f8b-26bcd403a57a",
  "event": "order.payment.settled",
  "version": "1.0",
  "timestamp": 1692011944,
  "payload": {
    "order_id": "order_2345343214521452",
    "order": {
      "name": "Ron Rivest",
      "phone": "9876543210",
      "identifier": "26bcd403a57a",
      "email": "customer@example.com",
      "paid_at": "2023-04-04T04:00:38Z",
      "status": "paid",
      "details": [
        {
          "component_type": "Admission Fee",
          "amount": 10000.0,
          "settlement_utr": "test_123",
          "settled_at": "2023-04-04T04:00:38Z"
        }
      ],
      "notes": [
        {
          "key": "erp_reference_id",
          "value": "REF123"
        }
      ]
    }
  }
}

Handling the Event

Upon receiving the order.payment.settled event, you can update the paid order’s settlement UTR.