Pay
Pay covers payment collection flows in Jodo: student-linked payments, ad-hoc checkout orders, and shareable payment links.
Use student-linked Pay when the student exists in Jodo and the payment should update the student’s payment history. Use checkout orders or payment links when the payer does not need to exist as a student first.
Collection Modes
Section titled “Collection Modes”- Student-linked Pay: collect tuition, school, transport, or other structured fees against a Jodo student.
- Checkout order: create a hosted checkout order for event fees, application fees, registration payments, or other ad-hoc collections.
- Payment link: create a hosted payment URL that can be shared with a payer and optionally expire later.
Checkout orders and payment links both return an order_id and a hosted redirect_url. Use the order_id to fetch status and reconcile webhooks.
Student-Linked APIs
Section titled “Student-Linked APIs”The student APIs used by Flex are also used by Pay. Use them to register students, retrieve student records, update student details, update fee structures, and list student payments.
Register Student
Create a student record that Pay collections can be linked against.
Open reference → Student APIGet Student
Retrieve student details by Jodo student ID.
Open reference → Student APIUpdate Student
Update student profile details used across Jodo products.
Open reference → Student APIUpdate Fee
Update fee components for a student.
Open reference → Student APIList Payments
Fetch payment history for a student.
Open reference →Checkout and Payment Link APIs
Section titled “Checkout and Payment Link APIs”Create Pay Order
Create a hosted checkout order and receive an order ID and redirect URL.
Open reference → Checkout OrderGet Pay Order
Fetch order status, payment details, settlement details, and notes by order ID.
Open reference → Payment LinkCreate Payment Link
Create a shareable payment link and receive a hosted payment URL.
Open reference → Payment LinkGet Payment Link
Fetch payment link status, transaction details, and settlement details.
Open reference → Payment LinkCancel Payment Link
Cancel an unpaid payment link by order ID.
Open reference →Webhooks
Section titled “Webhooks”Subscribe to Pay webhooks to receive debit, settlement, and expiry updates across student-linked payments, checkout orders, and payment links.
payment.debited
A payment has been successfully debited from the customer.
Webhookpayment.settled
The payment has been settled to the institute's bank account.
Checkout Orderorder.payment.debited
A checkout order payment has been successfully debited.
Checkout Orderorder.payment.settled
A checkout order payment has been settled to the institute's account.
Payment Pagepage.payment.debited
A payment page payment has been successfully debited.
Payment Pagepage.payment.settled
A payment page payment has been settled to the destination account.
Payment Linkpayment_link.payment.debited
A payment link has been paid by the payer.
Payment Linkpayment_link.payment.settled
A payment link payment has been settled to the institute's account.
Payment Linkpayment_link.payment.expired
A payment link has expired before payment was completed.