Add Payment

Record a manual (direct) payment for a student identified by :jodo_student_id.

Endpoint

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

Request

curl -X POST 'https://[base_url]/api/v1/integrations/erp/students/:jodo_student_id/payments' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic <token>' \
  -d '{
    "amount": 2000,
    "paid_at": "2022-01-29T10:05:45Z",
    "mode": "cash",
    "transaction_id": "tra_1234",
    "settlement_utr": "settl_1234",
    "notes": "advance payment",
    "fee_components": [
      {
        "component_type": "TUITION_FEE",
        "amount": 1000
      },
      {
        "component_type": "TRANSPORT_FEE",
        "amount": 1000
      }
    ]
  }'

Path Parameters

Parameter	Type	Required	Description
jodo_student_id	string	Yes	Jodo student ID against which the payment should be recorded.

Request Body

Attribute	Type	Required	Description
amount	number	Yes	Total amount paid.
paid_at	datetime	Yes	Paid date and time in ISO 8601 format.
mode	string	No	Mode of payment. Defaults to others if not provided.
transaction_id	string	No	Unique transaction ID from your system.
settlement_utr	string	No	Settlement UTR, if already available.
notes	string	No	Payment notes.
fee_components	array	Yes	Fee component level payment allocation.
fee_components[].component_type	string	Yes	Fee component for which payment is made.
fee_components[].amount	number	Yes	Amount paid for this fee component.

Response

HTTP 201

{
  "status": "success"
}

Errors

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