Introduction

Welcome to the StudentPay Provider Checkout API.

StudentPay helps education providers enrol students on compliant payment plans, collect direct-debit authority, generate agreements, and keep plan administration out of the provider’s day-to-day ops.

This documentation is for software vendors and education-provider engineering teams integrating enrolment wizards against StudentPay.

What you can build

Create a provider checkout (student Contact + Opportunity / payment plan, optional DDA)
Collect bank authority via the returned direct-debit setup URL
Confirm enrolment (declarations, agreement PDF, Opportunity stage update)
Retrieve checkout status for the wizard and support tooling

Start here

Resource	Purpose
Quickstart	End-to-end integrate in four steps
Environments	Sandbox vs production hosts
Authentication	Provider API keys
API Reference	Interactive per-endpoint docs
OpenAPI	Machine-readable contract

Base URLs

Environment	Base URL
Sandbox	`https://sandbox-api.studentpay.com.au`
Production	`https://api.studentpay.com.au`

Always integrate against sandbox first. Confirm readiness:

curl https://sandbox-api.studentpay.com.au/v1/environment

Expect "environment": "sandbox", "pinch_mode": "test", and "ready_for_api_calls": true.

Compatibility

Legacy OnFit routes remain available:

POST /api/provider-checkout
POST /api/provider-checkout-confirm

New providers should use /v1 only.

Start quickstart Open API Reference