Docs home

List Payments

Lists the payments recorded for a learner, plus refunds, newest first. Use it to reconcile what a learner has paid.

GET/invoices/payments
List Payments
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/invoices/payments?org_id=10608&student_id=93122884&response_type=1' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "payments": [
    {
      "collected_on": 1783036800,
      "invoice_payment_id": 885745,
      "to_collect": 7762,
      "notes": "",
      "mode": 4,
      "ref_no": "",
      "payment_number": 5048,
      "credits_applied": 0,
      "cheque_id": 0,
      "currency_id": 49,
      "num_of_decimals": 2,
      "position": 1,
      "custom_symbol": "₹",
      "transaction_type": 1,
      "refundable_amount": "7762.00000",
      "invoice_payment_gateway": -1,
      "payment_gateway_payment_id": "",
      "currency_symbol": "₹"
    },
    {
      "collected_on": 1781308800,
      "invoice_payment_id": 872739,
      "to_collect": 8000,
      "notes": "",
      "mode": 4,
      "ref_no": "",
      "payment_number": 4628,
      "credits_applied": 0,
      "cheque_id": 0,
      "currency_id": 49,
      "num_of_decimals": 2,
      "position": 1,
      "custom_symbol": "₹",
      "transaction_type": 1,
      "refundable_amount": "8000.00000",
      "invoice_payment_gateway": -1,
      "payment_gateway_payment_id": "",
      "currency_symbol": "₹"
    },
    {
      "collected_on": 1780444800,
      "invoice_payment_id": 864709,
      "to_collect": 3000,
      "notes": "",
      "mode": 4,
      "ref_no": "",
      "payment_number": 4400,
      "credits_applied": 0,
      "cheque_id": 0,
      "currency_id": 49,
      "num_of_decimals": 2,
      "position": 1,
      "custom_symbol": "₹",
      "transaction_type": 1,
      "refundable_amount": "3000.00000",
      "invoice_payment_gateway": -1,
      "payment_gateway_payment_id": "",
      "currency_symbol": "₹"
    }
  ]
}

Access: Institute admins, admins of an organization the learner belongs to, plus custom roles that can view learners.

Query parameters
student_idintegerrequired
The learner's user ID.
org_idinteger
Organization to check your admin rights in. Defaults to your ORGID header.
1 returns each payment as an object with named fields (recommended).
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
paymentsobject[]
Show child attributesHide child attributes
Unix timestamp
Example: 1783036800
Example: 885745
Amount, formatted string
Example: 7762
1 Online, 2 Cash, 3 Cheque, 4 Card, 5 Paytm, 6 UPI, 7 Student loan, 8 Net banking, 9 Stripe, 10 PayPal
Example: 4
Example: 5048
Example: 0
Example: 0
Example: 49
Example: 2
Example: 1
Example: ₹
1 payment, 2 refund
Example: 1
Example: 7762.00000
Example: ₹

Notes: Only payments recorded in your organizations are listed. Error "User is not in your org." when you aren't an admin of an organization the learner belongs to. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI