Create Payment Link

Create a payment link when the payer should complete payment from a shareable hosted URL instead of an immediate checkout redirect.

Endpoint

POST /api/v1/integrations/pay/payment_links

Request

curl --location 'https://[base_url]/api/v1/integrations/pay/payment_links' \
  --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": 1.0
      }
    ]
  }'

Request Body

Attribute	Type	Description
name	String	Customer name. Required.
phone	String	Customer phone number. Required.
email	String	Customer email address. Required.
student_name	String	Optional student name for display and reconciliation.
grade	String	Optional grade identifier shared between Jodo and the ERP provider.
date_of_birth	String	Optional student date of birth.
identifier	String	Optional student identifier assigned by the institute.
new_admission	Boolean	Indicates whether the student is a new admission.
custom_identifier	String	Optional student custom identifier.
academic_year_start	Integer	Academic year start.
academic_year_end	Integer	Academic year end.
expires_at	Datetime	Optional expiry date and time in ISO 8601 format.
details	Array	Payment detail rows. Required.
details[].component_type	String	Payment detail type. Required.
details[].amount	Number	Amount to be collected. Required.
notes	Array	Optional key-value metadata, for example [{"key": "erp_reference_id", "value": "REF123"}].

Response

HTTP 201

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

Errors

Code	HTTP Code	Description
HUE00000	400	Bad request error.

Implementation Notes

• Store data.order_id; it is used for status checks, cancellation, and webhook reconciliation.
• Share data.redirect_url with the payer through your own communication channel.
• Use notes for ERP references, event IDs, campaign IDs, or admission workflow IDs.