Docs home

Get Purchase Details

Returns one course purchase with its instalments: amounts, due dates, invoices, GST and payment status. Use it to show a learner what they owe and what they've paid.

GET/institution/bookings/{payment_id}
Get Purchase Details
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/institution/bookings/{payment_id}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "booking": {
    "package_id": 76006,
    "institution_id": 1613,
    "discount": 0.85,
    "total_amount": 9.84,
    "currency_symbol": "₹",
    "position": 1,
    "date_of_commencement": "",
    "institution_name": "darwin",
    "package_name": "Course 2",
    "student_name": "DemoHemal",
    "student_email": "hemal@edmingle.com",
    "student_contact_number": "7359943259",
    "payment_status": "pending",
    "organization_id": 1943,
    "institution_bundle_id": 111812,
    "organization_name": "Edmingle Academy",
    "is_free_enrolment": 0,
    "pretty_name": "Course2",
    "date_of_enrolment": "15/07/2026",
    "is_course_enrollment_allowed": 1,
    "payment_gateway": 8,
    "is_gst_exclusive": 0,
    "part_details": [
      {
        "part_id": 4633352,
        "payment_mode": 1,
        "amount": 9.84,
        "usd_amount": 0,
        "payment_status": "pending",
        "due_date": "15/07/2026",
        "ref_no": "",
        "paid_on": 0,
        "cheque_date": "",
        "instamojo_payment_link": null,
        "payment_gateway": -1,
        "invoice_id": 4702764,
        "amount_due": 8.99,
        "amount_due_pre_gst": 7.62,
        "invoice_number": "789",
        "discount": 0.85,
        "final_amount": 8.99,
        "due_date_gmt": 1784073600,
        "credits_applied": 0,
        "installment_name": "Full Payment",
        "is_igst": 1,
        "igst_per": 18,
        "igst_amount": 1.37,
        "sgst_per": 0,
        "sgst_amount": 0,
        "cgst_per": 0,
        "cgst_amount": 0,
        "enable_gst": 1,
        "place_of_supply": "",
        "cheque_ids": null,
        "cheque_amounts": "0",
        "cheque_status": null,
        "currency_symbol": "₹",
        "position": 1,
        "currency_id": 49,
        "is_recurring_part": 0,
        "invoice_payment_id": null,
        "cheque_details": []
      }
    ]
  }
}

Access: Learners (their own purchases) and parents (their children's). Other roles get "Invalid user (user is not student)."

Path parameters
payment_idintegerrequired
The purchase ID (payment_id from "Course Purchase List").
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
bookingobject
Show child attributesHide child attributes
Course ID
Example: 76006
Example: 1613
Example: 0.85
Example: 9.84
Example: ₹
Example: 1
Example: darwin
Example: Course 2
Example: DemoHemal
Example: hemal@edmingle.com
Example: 7359943259
pending or cleared
Example: pending
Example: 1943
Example: 111812
Example: Edmingle Academy
Example: 0
Example: Course2
Dd/mm/yyyy
Example: 15/07/2026
The gateway to use for paying
Example: 8
Example: 0
Show child attributesHide child attributes
Example: 4633352
Example: 9.84
pending or cleared
Example: pending
Dd/mm/yyyy
Example: 15/07/2026
The gateway to use for paying
Example: -1
Example: 4702764
Example: 1784073600
Example: Full Payment

Notes: Amounts are formatted strings. Error "Enrollment Not Found. Please Contact Admin" when the purchase isn't yours. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI