Developers
Connect StudentPay to your enrolment journey
The StudentPay API is the education payment interface for connecting Enrolment Integration or Enrolment Checkout — creating payment plans from enrolment and retrieving reporting data from your systems.
StudentPay Enrolment Integration is for providers who keep their own digital enrolment journey. Your developers use the StudentPay API to connect that journey so the payment-plan experience sits in your workflow — an education payment integration rather than a generic checkout overlay.
StudentPay Enrolment Checkout is for providers who want StudentPay to provide the enrolment and payment-plan experience. Technical teams can still connect it through the API.
StudentPay Agent Setup does not require the API. Your team creates the payment plan with the student during sales or enrolment.
The marketing site does not replace API documentation. Technical reference lives at docs.studentpay.co.nz.
Production API: https://api.studentpay.co.nz
Sandbox API: https://sandbox-api.studentpay.co.nz
Need help going live? See integration support or request sandbox access. Payment-plan operations after enrolment are covered on payment plans.
{
"provider_id": "pte_1042",
"student": {
"name": "Alex Reed",
"email": "alex@example.nz"
},
"amount": 1050.00,
"currency": "NZD",
"schedule": "weekly",
"instalments": 12
}