Payments NZ API standards


Introduction

Welcome to our Confluence space. This is where you can view all published versions of our standards for the Payment Initiation and Account Information APIs. We have also published supporting documentation to help inform understanding of the standards and how to utilise all the different functionalities.

Information on which version of the standards API Providers are currently using is available to registered Standards Users to assist with partnering. You can also get in touch directly with each API Provider to find out more.

These specifications are read-only and are publicly available so businesses can think about how they might be used as part of their customer solutions.

Only registered Standards Users of our API Centre have the right to use the standards and form bilateral agreements with other registered Standards Users. To find our more or to apply to become a Standards User, visit our API Centre website.

The 'NZ Banking Data Security Profile' supports our published APIs and defines the security standards to be used for the API ecosystem. It sets out how a Third Party connects securely to API Providers and compliments the NZ Banking Data Specifications. The published security profiles support the corresponding published version of the standards.

To view the API specifications, simply click the link for the documentation you’re interested in.


NZ Banking Data Specs

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 either the
Payment Initiation or Account Information API specifications.

Currently published specifications can be found below.

Version 1.0.0

Version 2.0.0

Version 2.0.1

Version 2.1.0


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.

Currently published specifications can be found below.

Version 1.0.0

Version 2.0.0

Version 2.0.1

Version 2.1.0

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.

Currently published specifications can be found below.

Version 1.0.0

Version 2.0.0

Version 2.0.1

Version 2.1.0


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.