1 Version Control
2 Overview
- 2.1 Overview Diagram
  - 2.1.1 Steps
- 2.2 Document Structure
- 2.3 Known Issues
- 2.4 Design Principles
  - 2.4.1 RESTful APIs
  - 2.4.2 Standards
  - 2.4.3 Extensibility
  - 2.4.4 Idempotency
  - 2.4.5 Message Signing
  - 2.4.6 Message Encryption
  - 2.4.7 Agnostic to Payment Schemes
  - 2.4.8 Status Codes
  - 2.4.9 Unique Identifiers (Id Fields)
  - 2.4.10 Categorisation of Implementation Requirements
    - 2.4.10.1 Mandatory
    - 2.4.10.2 Optional
  - 2.4.11 Open Banking UK
3 Basics
- 3.1 Actors
- 3.2 Character Encoding
- 3.3 Date Formats
- 3.4 Resource URI Path Structure
- 3.5 Headers
  - 3.5.1 Request Headers
  - 3.5.2 Response Headers
- 3.6 HTTP Status Codes
  - 3.6.1 403 (Forbidden) v/s 404 (Not Found) v/s 501 (Not Implemented)
  - 3.6.2 403 (Forbidden)
  - 3.6.3 401 (Unauthorized)
  - 3.6.4 429 (Too Many Requests)
- 3.7 Pre-Conditions
  - 3.7.1 Pre-conditions for Third Parties
  - 3.7.2 Pre-conditions for API Providers
- 3.8 Idempotency
- 3.9 Filtering
- 3.10 Pagination
- 3.11 Archiving
4 Security & Access Control
- 4.1 Scopes
- 4.2 Consent Authorisation
- 4.3 Token Expiry
  - 4.3.1 Token Expiry Time
- 4.4 Supported Grant Types
  - 4.4.1 Client Credentials Grant
  - 4.4.2 Redirect Flow (Hybrid)
    - 4.4.2.1 ID Token
    - 4.4.2.2 Error Condition
  - 4.4.3 Decoupled Flow (CIBA)
    - 4.4.3.1 ID Token Hint
    - 4.4.3.2 Login Hint Token
      - 4.4.3.2.1 UML Diagram
      - 4.4.3.2.2 Data Model
      - 4.4.3.2.3 Example
- 4.5 Changes to Consent Status
- 4.6 Consent Re-authorisation
  - 4.6.1 Use of Refresh Token
- 4.7 Risk Scoring Information
5 Data Model
- 5.1 Common Payload Structure
  - 5.1.1 Request Structure
    - - 5.1.1.1.1 Request
    - 5.1.1.2 Data
    - 5.1.1.3 Risk
  - 5.1.2 Response Structure
    - - 5.1.2.1.1 Response
    - 5.1.2.2 Links
      - 5.1.2.2.1 Example Links (Self only)
      - 5.1.2.2.2 Example Links
    - 5.1.2.3 Meta
      - 5.1.2.3.1 Example Meta
  - 5.1.3 Error Response Structure
    - - 5.1.3.1.1 Response
    - 5.1.3.2 UML Diagram
    - 5.1.3.3 Data Dictionary
      - 5.1.3.3.1 Enumerations
- 5.2 Optional Fields
- 5.3 Enumerations
- 5.4 Common Classes
  - 5.4.1 NZRisk1
    - 5.4.1.1 UML Diagram
    - 5.4.1.2 Notes
    - 5.4.1.3 Data Dictionary
6 Usage Examples
- 6.1 Pagination Flows
  - 6.1.1 Request
  - 6.1.2 Paginated Resource Response
  - 6.1.3 Request Next Page of Results
  - 6.1.4 Paginated Resource Response (Next)
- 6.2 Error Flows
  - 6.2.1 Missing or Expired Access Token
  - 6.2.2 Incomplete or Malformed Request Payload
  - 6.2.3 Missing or Invalid Access Token Scope
  - 6.2.4 Sudden Burst of API Requests
  - 6.2.5 Failed Authorisation Consent

Version Control

Version	Date	Author	Comments

Version	Date	Author	Comments
1.0.0	01 March 2019	Payments NZ API Working Group	Baseline
v2.0-draft1	Jun 4, 2019

Payments NZ API standards

NZ Banking Data API Specification v2.0.2

Version Control