Retrieve a Student Booking
Returns one booking (enrollment payment) of a learner with its instalments, invoices and payment links. Use it to show a learner's fee schedule or check what has been paid. Get the booking ID (`payment_id`) from "Admin Retrieve Course of Student Enrolled".
GET
/institution/user/bookings/{payment_id}Retrieve a Student Booking
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/institution/user/bookings/{payment_id}?user_id=<user_id>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"booking": {
"package_id": 95,
"institution_id": 1,
"discount": 0,
"total_amount": 10000,
"usd_total_amount": null,
"date_of_commencement": "",
"institution_name": "Institution 1",
"package_name": "Test Package zzz",
"student_name": "vaibhav",
"student_email": null,
"student_contact_number": "9794554548",
"payment_status": "pending",
"promocode_text": "",
"is_online_package": 1,
"is_test_series": 0,
"base_currency_id": 1,
"currency_id": 1,
"conversion_rate": "1.00000",
"adjustment_rate": "0.00000",
"num_of_decimals": 2,
"position": 1,
"currency_symbol": "$",
"organization_id": 2,
"date_of_enrolment": "20/05/2022",
"part_details": [
{
"part_id": 5087,
"payment_mode": 1,
"amount": 2000,
"usd_amount": 0,
"payment_status": "pending",
"due_date": "25/05/2022",
"ref_no": "",
"paid_on": 1652985000,
"cheque_date": "",
"instamojo_payment_link": null,
"payment_gateway": -1,
"paypal_url": null,
"invoice_id": 5129,
"amount_due": 1980,
"invoice_number": 1310,
"discount": 0,
"final_amount": 2000,
"due_date_gmt": 1653436800,
"credits_applied": 0,
"installment_name": "Installment",
"is_igst": 0,
"igst_per": 0,
"igst_amount": 0,
"sgst_per": 0,
"sgst_amount": 0,
"cgst_per": 0,
"cgst_amount": 0,
"enable_gst": 0,
"place_of_supply": "KARNATAKA",
"cheque_ids": null,
"cheque_amounts": "0",
"cheque_status": null,
"currency_symbol": "$",
"position": 1,
"currency_id": 1,
"cheque_details": []
},
{
"part_id": 5088,
"payment_mode": 1,
"amount": 3000,
"usd_amount": 0,
"payment_status": "pending",
"due_date": "20/07/2022",
"ref_no": "",
"paid_on": 0,
"cheque_date": "",
"instamojo_payment_link": null,
"payment_gateway": -1,
"paypal_url": null,
"invoice_id": 5130,
"amount_due": 3000,
"invoice_number": 1311,
"discount": 0,
"final_amount": 3000,
"due_date_gmt": 1658275200,
"credits_applied": 0,
"installment_name": "Installment",
"is_igst": 0,
"igst_per": 0,
"igst_amount": 0,
"sgst_per": 0,
"sgst_amount": 0,
"cgst_per": 0,
"cgst_amount": 0,
"enable_gst": 0,
"place_of_supply": "KARNATAKA",
"cheque_ids": null,
"cheque_amounts": "0",
"cheque_status": null,
"currency_symbol": "$",
"position": 1,
"currency_id": 1,
"cheque_details": []
},
{
"part_id": 5089,
"payment_mode": 1,
"amount": 5000,
"usd_amount": 0,
"payment_status": "pending",
"due_date": "18/08/2022",
"ref_no": "",
"paid_on": 0,
"cheque_date": "",
"instamojo_payment_link": null,
"payment_gateway": -1,
"paypal_url": null,
"invoice_id": 5131,
"amount_due": 5000,
"invoice_number": 1312,
"discount": 0,
"final_amount": 5000,
"due_date_gmt": 1660780800,
"credits_applied": 0,
"installment_name": "Installment",
"is_igst": 0,
"igst_per": 0,
"igst_amount": 0,
"sgst_per": 0,
"sgst_amount": 0,
"cgst_per": 0,
"cgst_amount": 0,
"enable_gst": 0,
"place_of_supply": "KARNATAKA",
"cheque_ids": null,
"cheque_amounts": "0",
"cheque_status": null,
"currency_symbol": "$",
"position": 1,
"currency_id": 1,
"cheque_details": []
}
]
}
}Access: Institute admins, plus custom roles that can view learners.
Path parameters
Booking ID (
payment_id).Query parameters
The learner's user ID (or their parent's). The booking must belong to this learner.
Response
codeinteger
Example:
200messagestring
Example:
Successbookingobject
Show child attributesHide child attributes
booking.package_idinteger
Example:
95booking.institution_idinteger
Example:
1booking.discountinteger
Example:
0booking.total_amountinteger
Example:
10000booking.institution_namestring
Example:
Institution 1booking.package_namestring
Example:
Test Package zzzbooking.student_namestring
Example:
vaibhavExample:
9794554548booking.promocode_textstring
booking.is_online_packageinteger
Example:
1booking.is_test_seriesinteger
Example:
0booking.base_currency_idinteger
Example:
1booking.currency_idinteger
Example:
1booking.conversion_ratestring
Example:
1.00000booking.adjustment_ratestring
Example:
0.00000booking.num_of_decimalsinteger
Example:
2booking.positioninteger
Example:
1booking.currency_symbolstring
Example:
$booking.organization_idinteger
Example:
2booking.part_detailsobject[]
Show child attributesHide child attributes
booking.part_details.part_idinteger
Example:
50871 Online, 2 Cash, 3 Cheque, 4 Card, 5 PayTM, 6 UPI, 7 Student Loan, 8 Net Banking, 9 Stripe, 10 PayPalExample:
1booking.part_details.amountinteger
Example:
2000Example:
0Example:
-1Example:
5129Example:
1980Example:
1310Example:
0Example:
2000Example:
1653436800Example:
0Example:
Installmentbooking.part_details.is_igstinteger
Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
KARNATAKAExample:
0Example:
$Example:
1Example:
1Notes: When GST is exclusive, total_amount is shown before GST. Errors: "Invalid user (user is not student)." and "Enrollment Not Found. Please Contact Admin". Rate limit: 200 requests per 1 minute; going over locks you out for 30 minutes.