List Payments

Retrieve the payment list for a student identified by :jodo_student_id.

Endpoint

GET /api/v1/integrations/erp/students/:jodo_student_id/payments

Request

curl -X GET 'https://[base_url]/api/v1/integrations/erp/students/:jodo_student_id/payments' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic <token>'

Path Parameters

Parameter	Type	Required	Description
jodo_student_id	string	Yes	Jodo student ID for which payments should be listed.

Response

HTTP 200

{
  "status": "success",
  "data": [
    {
      "id": "pg_1909",
      "amount": 2000.0,
      "product": "pg",
      "mode": "pg",
      "paid_at": "2023-04-27T05:15:58Z",
      "details": [
        {
          "fee_component": "ADMISSION_FEE",
          "amount": 2000.0,
          "settlement_utr": null,
          "settled_at": null
        }
      ]
    }
  ]
}

Response Data

Attribute	Type	Description
data[].id	string	Payment ID.
data[].amount	number	Payment amount.
data[].product	string	Jodo payment product.
data[].mode	string	Payment mode.
data[].paid_at	datetime	Paid date and time.
data[].details	array	Fee component level payment breakdown.
data[].details[].fee_component	string	Fee component type.
data[].details[].amount	number	Amount paid for the fee component.
data[].details[].settlement_utr	string or null	Settlement UTR, if available.
data[].details[].settled_at	datetime or null	Settlement date and time, if available.

Errors

Code	HTTP Code	Description
MAE00000	400	Bad request error.
MAE00001	404	Student not found.