Get Payment Link

Use this API to fetch the current state of a payment link using the order_id returned when the link was created.

Endpoint

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

Request

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

Path Parameters

Parameter	Type	Required	Description
order_id	string	Yes	Payment link order ID returned by Create Payment Link.

Response

HTTP 200

{
  "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.0,
        "settlement_utr": "settl_1234",
        "settled_at": "2022-03-02T10:05:45Z"
      }
    ]
  }
}

Response Data

Attribute	Type	Description
data.id	String	Order ID.
data.expires_at	String	Payment link expiry date and time.
data.name	String	Customer name.
data.phone	String	Customer phone number.
data.email	String	Customer email address.
data.identifier	String	Student identifier assigned by the institute.
data.student_name	String	Student name.
data.grade	String	Grade identifier shared between Jodo and the ERP provider.
data.stream	String	Student stream name.
data.academic_year_start	Integer	Academic year start.
data.academic_year_end	Integer	Academic year end.
data.new_admission	Boolean	Indicates whether the student is a new admission.
data.date_of_birth	String	Student date of birth.
data.custom_identifier	String	Student custom identifier.
data.transaction_id	String	Transaction ID for the payment.
data.paid_at	Datetime	Time when the payment was completed.
data.status	String	Current status: paid, unpaid, expired, or cancelled.
data.details	Array	Payment detail rows.
data.details[].component_type	String	Payment detail type.
data.details[].amount	Number	Amount for the payment detail.
data.details[].settlement_utr	String	Settlement UTR, if settled.
data.details[].settled_at	Datetime	Settlement time, if settled.
data.notes	Array	Key-value metadata attached during payment link creation.

Errors

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