Payments NZ API standards

Introduction

Welcome to our Confluence space. This is where you can view version 1.0.0 of the standards for the Payment Initiation and Account Information APIs. These standards are read-only.

We’ve made the version 1.0.0 standards available in advance of the API standards service so you can think about how they might be used as part of your customer solutions.
Once the service is open, organisations will be able to apply to become registered standards users. Only registered standards users will be able to enter into bilateral
arrangements using these standards. You can find out more about the API workstream and upcoming service on our website.

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


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.


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.

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.


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.
  • Once the API standards service is open, interested API providers and third parties can apply to become a registered standards user.
  • Only registered standards users will be able to enter into bilateral arrangements using these standards.