Docs home

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
payment_idintegerrequired
Booking ID (payment_id).
Query parameters
user_idintegerrequired
The learner's user ID (or their parent's). The booking must belong to this learner.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
bookingobject
Show child attributesHide child attributes
Example: 95
Example: 1
Example: 0
Example: 10000
Example: Institution 1
Example: Test Package zzz
Example: vaibhav
Example: 9794554548
pending or cleared
Example: pending
Example: 1
Example: 0
Example: 1
Example: 1
Example: 1.00000
Example: 0.00000
Example: 2
Example: 1
Example: $
Example: 2
DD/MM/YYYY
Example: 20/05/2022
Show child attributesHide child attributes
Example: 5087
1 Online, 2 Cash, 3 Cheque, 4 Card, 5 PayTM, 6 UPI, 7 Student Loan, 8 Net Banking, 9 Stripe, 10 PayPal
Example: 1
Example: 2000
pending or cleared
Example: pending
DD/MM/YYYY
Example: 25/05/2022
Unix timestamp
Example: 1652985000
Example: 1653436800
Example: Installment
Example: KARNATAKA

Notes: 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.

Updated yesterday

Ask AI