Payments NZ API standards Home
NZ Banking Data API Specification
These specifications are to be used in the implementation of both standards. It provides a description
of the elements that are common across both. It should be read in conjunction with the
Payment Initiation. Account Information API or Event Notification specifications.
The most up to date currently published specifications can be found below.
Version 1.0.0
Version 2.0.2
Version 2.1.3
Version 2.2.3
Version 2.3.3
Version 3.0.1
Security profile
The security profile defines how Standards Users will securely and safely interact using the industry standardised APIs. It is built on top of layers of proven financial grade security best practice and has been tailored to the NZ market to support Open Banking uses.
From version 3.0.0 onwards, the security profile has been decoupled from the rest of the functional specs and will be managed independently of the other API specifications.
The most up to date currently published specifications can be found below.
Version 1.0.0
Version 2.0.2
Version 2.1.3
Version 2.2.3
Version 2.3.3
Version 3.0.1
Account Information
Account Information will enable registered Third Party standards users, with customer consent, to access specific financial information relating to an account. This specification is unique to the implementation of this API.
The most up to date currently published specifications can be found below.
Version 1.0.0
Version 2.0.2
Version 2.1.3
Version 2.2.3
Version 2.3.3
Version 3.0.1
Payment Initiation
Payments Initiation will enable registered Third Party standards users, with customer consent, to set up and make an electronic credit payment by connecting directly and safely with banks. This specification is unique to the implementation of this API.
The most up to date currently published specifications can be found below.
Version 1.0.0
Version 2.0.2
Version 2.1.3
Version 2.2.3
Version 2.3.3
Version 3.0.1
Event notification
Enables allow Third Parties to establish subscriptions to be notified of changes to provider held resources. Establishing a subscription is optional for Third Parties, but if they choose to subscribe they must provide an endpoint as defined in the standard. This specification is unique to the implementation of this API.
The most up to date currently published specifications can be found below.
Version 3.0.1
Disclaimer
- The API standards are published for information only and Payments NZ does not make any warranty or representation regarding the API standards, including warranties as to description, merchantability, that the API Standards will be free from defects, or otherwise fit for purpose.
- These API standards are read only.
- Only registered standards users will be able to enter into bilateral arrangements using these standards.