Introduction
Welcome to the StudentPay NZ Provider Checkout API.
This documentation is for software vendors and education-provider engineering teams integrating New Zealand enrolment checkouts.
StudentPay helps you:
- Create a provider checkout for a student payment plan
- Send the payer to hosted BECS NZ direct-debit setup
- Confirm enrolment after setup is complete
- Receive a Payment Plan Agreement reference
After confirmation, Salesforce creates the payment schedule and owns later collection. Your integration does not submit payments.
Direct debit setup complete is not the same as Authorised. Authorised means the GoCardless mandate is active.
What this API does not do
- It does not collect instalments
- It does not treat hosted setup as Authorised
- It does not expose a public agreement PDF download
- It does not require the GoCardless mandate to be
activebefore confirm
Start here
| Resource | Purpose |
|---|---|
| Quickstart | Sandbox journey from API key to confirmed enrolment |
| Direct Debit Setup | Setup complete versus Authorised |
| Checkout Lifecycle | Provider-facing states |
| Authentication | Provider API keys |
| API Reference | Interactive OpenAPI reference |
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox (recommended) | https://sandbox-api.studentpay.co.nz |
| Production | https://api.studentpay.co.nz |
Always integrate against sandbox first:
curl https://sandbox-api.studentpay.co.nz/v1/environment
Expect "environment": "sandbox", "payment_processor": "gocardless", and "ready_for_api_calls": true.
Public provider routes
| Method | Path |
|---|---|
GET |
/v1 |
GET |
/v1/environment |
POST |
/v1/provider-checkouts |
GET |
/v1/provider-checkouts/{checkoutId} |
POST |
/v1/provider-checkouts/{checkoutId}/confirm |
New providers should use /v1 only.