Payments Initiation API Specification - v2.1.0
- Matthew Bell
- 1 Version Control
- 2 Overview
- 2.1 Document Structure
- 2.2 Scope
- 2.3 Out of Scope
- 3 Basics
- 3.1 Overview
- 3.1.1 Overview Diagram
- 3.1.2 Steps
- 3.1.3 Sequence Diagram
- 3.2 Restrictions
- 3.3 Release Management
- 3.3.1 Enduring-Payment-Consents
- 3.3.2 Domestic-Payment-Consents
- 3.3.3 Domestic-Payments
- 3.1 Overview
- 4 Endpoints
- 5 Security & Access Control
- 5.1 Scopes
- 5.2 Grants Types
- 5.3 Consent Authorisation
- 5.4 Consent Re-authorisation
- 5.5 Consent Revocation
- 5.6 Consent Updates
- 6 Data Model
- 6.1 Identifier Fields
- 6.1.1 Key
- 6.1.2 Merchant Flow
- 6.1.3 Person to Person Flow
- 6.2 Enumerations
- 6.2.1 Common Enumerations
- 6.1 Identifier Fields
- 7 Alternative and Error Flows
- 8 Swagger Specifications
Version Control
Version | Date | Author | Comments |
|---|---|---|---|
2.0.0 | Apr 30, 2020 | Payments NZ API Working Group | Baseline |
2.1-draft1 | Jun 15, 2020 | @Gavin Wong (Unlicensed) | Updated:
|
Overview
This Payment Initiation API Specification describes the flows and payloads for initiating a {payment-order} using a staged {payment-order}-consent.
The API endpoints described here allow a Third Party to:
Register an intent to stage a {payment-order}-consent.
Subsequently submit a {payment-order} for processing.
Optionally retrieve the status of a {payment-order}-consent or {payment-order}.
A {payment-order} is defined as "an instruction by a payer or payee to its payment service provider requesting the execution of a payment transaction." This Payment API specification defines a hierarchy of:
{payment-order} is a generic type; in this specification this generic type has one specific resource: