Get Pay Order

Use this API to retrieve the current state of a Pay Order after checkout, callback, or webhook processing.

Endpoint

GET /api/v1/integrations/pay/orders/:order_id

Request

curl -X GET 'https://[base_url]/api/v1/integrations/pay/orders/:order_id' \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json'

URL Parameters

Parameter	Description
order_id	Jodo Pay Order identifier returned by the Create Pay Order API.

Response

{
  "status": "success",
  "data": {
    "id": "order_12345",
    "name": "Customer Name",
    "phone": "9876543210",
    "email": "you@example.com",
    "transaction_id": "trans_568aaf1f9a65",
    "paid_at": "2022-03-01T10:05:45Z",
    "status": "paid",
    "details": [
      {
        "component_type": "Payable Amount",
        "amount": 1000,
        "settlement_utr": "settl_1234",
        "settled_at": "2022-03-02T10:05:45Z"
      }
    ],
    "notes": [
      {
        "key": "erp_reference_id",
        "value": "REF123"
      }
    ]
  }
}

Response Data

Field	Type	Description
data.id	string	Pay Order ID.
data.name	string	Payer name.
data.phone	string	Payer phone number.
data.email	string	Payer email address.
data.identifier	string	Student or payer identifier assigned by the institute, if provided.
data.student_name	string	Student name, if provided.
data.grade	string	Grade identifier, if provided.
data.stream	string	Stream name, if provided.
data.academic_year_start	integer	Academic year start, if provided.
data.academic_year_end	integer	Academic year end, if provided.
data.new_admission	boolean	Whether the order was associated with a new admission flow.
data.date_of_birth	string	Date of birth, if provided.
data.custom_identifier	string	Custom identifier, if provided.
data.transaction_id	string	Transaction ID for the payment.
data.paid_at	datetime	Time when payment was completed.
data.status	string	Current order status. Possible values: paid, unpaid.
data.details	array	Payment line items.
data.details[].component_type	string	Payment detail type.
data.details[].amount	number	Amount for the line item.
data.details[].settlement_utr	string	Settlement UTR, if settled.
data.details[].settled_at	datetime	Settlement time, if settled.
data.notes	array	Key-value metadata sent while creating the order.

Errors

Code	HTTP Code	Description
HUE00000	400	Bad request error.
HUE00001	404	Resource not found.