Developer Documentation
Developer Documentation
Home
Zip

Authentication & Authorization

Zip NZ uses OAuth 2.0 as a standardised means of securing API endpoints.

Flows

There is one OAuth flow currently supported:

Endpoints

There are 2 supported endpoints, which are reflective of either a sandbox or production environment.

Environment Token Endpoint API Identifier (audience)
Production https://merchant-auth-nz.zip.co/oauth/token https://auth.partpay.co.nz
Test https://merchant-auth-nz.sandbox.zip.co/oauth/token https://auth-dev.partpay.co.nz
Authentication Endpoints

NB that the previously defined endpoints will continue to function as they previously have, and your previously issued Client Id & Secret will be able to be used with both end points. There are no plans to retire the existing authentication endpoints.

Old endpoints

Environment Token Endpoint API Identifier (audience)
Production https://merchant-auth.partpay.co.nz/oauth/token https://auth.partpay.co.nz
Test https://partpay-dev.au.auth0.com/oauth/token https://auth-dev.partpay.co.nz