Student Enrollment in Course by Admin
Enrolls a student in a course as an offline (walk-in) admission: creates the student if needed, adds them to your organization and the chosen batches, and records the fee plan, instalments and the first payment mode. Use it when your own system collects the admission and fees.
POST
/admission/walkinStudent Enrollment in Course by Admin
curl --request POST \
--url 'https://<your-api-host>/nuSource/api/v1/admission/walkin' \
--form 'JSONString={"package_id":76006,"institution_id":1613,"student_name":"Smopad","student_email":"superadmin22@gmail.com","student_mobile_number_country_id":103,"payment_scheme":2127,"payment_mode":2,"promo_code_text":null,"academic_year":4,"organization_id":1943,"instalments":[{"instalment_name":"Full Payment","currency_symbol":"₹","position":1,"part_amount":9.09,"part_date":1784160000,"part_formatted_date":"16/07/2026","discount":5,"final_amount":4.09,"is_gst_exclusive":0,"gst_rate":18,"key":0,"old_instalment":1,"currency_id":49,"enable_gst":1,"igst_per":18,"cgst_amount":0,"sgst_amount":0,"igst_amount":0.62,"cgst_per":0,"sgst_per":0,"is_igst":true,"pre_gst_amount":3.47}],"fees_template_id":2127,"special_fees":[],"class_ids":[224496],"is_admission":1,"alt_contact_number":null,"courses_enrolled":["128495"],"date_of_admission":1784183038,"ed_background":"[{\"qualification\":\"\",\"yop\":\"\",\"institution\":\"\"}]","document_name":[],"place_of_supply":"ASSAM","inventory_details":{"items":[]},"organization_base_currency":49,"currency_id":49,"rate":"1.00000","adjustment_rate":"0.00000","num_of_decimals":2,"parent_contact_country_id":103,"force_add":0,"user_id":93229735}'{
"code": 200,
"message": "Success",
"user": {
"user_id": 43965,
"payment_id": 3920
},
"conflicting_students": []
}Access: Institute admins, plus custom roles that can create learners or make new admissions.
Request body: form-data with a JSONString field holding the JSON below. You can also attach document files as extra form-data file fields, labelled by document_name.
Body
JSONStringThe course (bundle) ID. From "Retrieve Course".
Your institution ID (from the meta API).
The organization (branch) to admit the student to.
Academic year of the course offering.
Student's full name.
Student's email.
Student's mobile number.
Country of the mobile number (from the country meta API).
user_idinteger
An existing student to enroll instead of creating a new one (from student search).
student_passwordstring
Password for a new student, up to 20 characters. A random 6-digit one is set if left out.
payment_schemeinteger
Fee template (instalment plan) ID. Send the same value in
fees_template_id.fees_template_idinteger
Fee template ID. Defaults to full down payment.
fees_recurring_idinteger
Recurring fee plan, if any.
payment_modeinteger
How the fee is collected:
1 Online, 2 Cash (default), 3 Cheque, 4 Card, 5 PayTM, 6 UPI, 7 Student Loan, 8 Net Banking, 9 Stripe, 10 PayPal.instalmentsarray
Instalments of the fee plan (fields below). Build them from the "CalculateSplit" API.
special_feesarray
Extra one-off fees (fields below).
[] if none.promo_code_textstring
A promo code to apply. Letters and digits only.
credits_appliednumber
Credits to apply against the first instalment. Default 0.
class_idsarray of integers
Classes (subject batches) to add the student to.
courses_enrolledarray
Curriculum course IDs.
is_admissioninteger
1 admit the student (status Admitted), 0 register only (status Registered, default).date_of_admissionUnix timestamp
Admission date. Default now.
force_addinteger
1 adds the student to batches even when their schedules clash. Default 0: a clash fails the request.currency_idinteger
Currency of the fees (for example
49 INR).organization_base_currencyinteger
Your organization's base currency ID.
ratenumber
Conversion rate to the base currency.
1 for the base currency.adjustment_ratenumber
Currency adjustment rate. Usually
0.num_of_decimalsinteger
Decimal places for amounts. Usually
2.place_of_supplystring
Indian state name for GST, for example
ASSAM. Decides IGST or CGST+SGST.Parent or guardian details. A parent account is created and linked when given.
reg_nostring
Registration number in your organization.
enquiry_idinteger
The lead this admission converts.
Profile details for a new student.
ed_backgroundstring
Education history as a JSON string:
[{"qualification": "", "yop": "", "institution": ""}].custom_fieldsarray
Signup custom field values:
[{"field_id": 1234, "field_value": "Engineering"}].document_namearray
Labels for the attached document files.
inventory_detailsobject
Items to hand over:
{"items": [{"item_id": 101, "quantity": 1}], "notes": ""}.Planned instalments for a registration (
is_admission 0).is_schedule_signup_mailinteger
0 skips the welcome email to a new student. Default 1.Fields in each instalments object:
| Name | Required | Type | Description |
|---|---|---|---|
| instalment_name | Yes | string | Label, for example Full Payment. |
| position | Yes | integer | Order, starting at 1. |
| part_amount | Yes | number | Amount before discount. Already includes GST for GST-inclusive pricing. |
| part_date | Yes | Unix timestamp | Due date. |
| discount | Yes | number | Discount on this instalment, or 0. |
| final_amount | Yes | number | Amount payable after discount. |
| currency_id | Yes | integer | Must match currency_id. |
| enable_gst | Yes | integer | 1 if GST applies. |
| is_gst_exclusive | Yes | integer | 0 GST included in the amount, 1 GST added on top. |
| gst_rate | Yes | number | Total GST rate, for example 18. |
| is_igst | Yes | boolean | true inter-state (IGST), false intra-state (CGST + SGST). |
| igst_per, cgst_per, sgst_per | Yes | number | Tax percentages; set the unused ones to 0. |
| igst_amount, cgst_amount, sgst_amount | Yes | number | Tax amounts. For inclusive pricing, tax = final_amount × rate / (100 + rate). |
| pre_gst_amount | Yes | number | final_amount minus tax. |
Fields in each special_fees object:
| Name | Required | Type | Description |
|---|---|---|---|
| id | Yes | integer | Special fee template ID. |
| amount | Yes | number | Fee amount. |
| date | Yes | Unix timestamp | Due date. |
| discount | No | number | Discount. Default 0. |
| currency_id | No | integer | Defaults to the enrollment currency. |
| is_igst, igst_per, cgst_per, sgst_per, igst_amount, cgst_amount, sgst_amount | No | number | GST split, as for instalments. |
Response
codeinteger
Example:
200messagestring
Example:
Successuserobject
Show child attributesHide child attributes
user.user_idinteger
Example:
43965user.payment_idinteger
Example:
3920conflicting_studentsarray
Empty on success
Notes:
- Fails with "Email Or Mobile Number Required", "Student Already Enrolled." or "Student Already Registered." if the student already has this course, and "User could not be enrolled in one or more class due to schedule conflict." when batches clash and
force_addis0. - A new student gets a welcome email with their login details unless
is_schedule_signup_mailis0. - Rate limit: 120 requests per minute; going over locks you out for 30 minutes. Attached files: PDF, JPEG, PNG or GIF, up to 1 MB each.