Create Pay Order

Create a Pay Order when you need to collect an unstructured payment without requiring an existing student record.

Endpoint

POST /api/v1/integrations/pay/orders

Request

curl --location 'https://[base_url]/api/v1/integrations/pay/orders' \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "name": "Customer Name",
    "phone": "9876543210",
    "email": "you@example.com",
    "details": [
      {
        "component_type": "Payable Amount",
        "amount": 1000
      }
    ],
    "callback_url": "https://www.example.com/payment/callback",
    "notes": [
      {
        "key": "erp_reference_id",
        "value": "REF123"
      }
    ]
  }'

Request Body

Field	Type	Required	Description
name	string	Yes	Name of the payer.
phone	string	Yes	Phone number of the payer.
email	string	Yes	Email address of the payer.
student_name	string	No	Student name, if relevant for the order. This does not require an existing Jodo student record.
grade	string	No	Grade identifier shared between Jodo and the ERP provider.
date_of_birth	string	No	Date of birth.
identifier	string	No	Student identifier assigned by the institute, if available.
new_admission	boolean	No	Indicates if the payer is associated with a new admission flow.
custom_identifier	string	No	Custom student or payer identifier.
academic_year_start	integer	No	Academic year start.
academic_year_end	integer	No	Academic year end.
details	array	Yes	Payment line items.
details[].component_type	string	Yes	Payment detail type, such as Event Fee or Payable Amount.
details[].amount	number	Yes	Amount to be collected for the line item.
callback_url	URL	No	URL used to redirect the payer after checkout.
notes	array	No	Key-value metadata, for example ERP reference IDs.

Response

{
  "status": "success",
  "data": {
    "order_id": "order_123456789",
    "redirect_url": "https://pay.jodo.in/p/xxx/xxx"
  }
}

Response Data

Field	Type	Description
data.order_id	string	Unique Jodo Pay Order identifier.
data.redirect_url	URL	Hosted Jodo checkout URL for the payer.

Errors

Code	HTTP Code	Description
HUE00000	400	Bad request error.