Domestic Payments - v2.1.0
- Matthew Bell
- 1 Version Control
- 2 Definition
- 3 Endpoints
- 4 State Model
- 4.1 Diagram
- 4.2 Definitions
- 5 Data Model
- 5.1 Domestic Payment - Request
- 5.1.1 UML Diagram
- 5.1.2 Notes
- 5.1.3 Data Dictionary
- 5.2 Domestic Payment - Response
- 5.2.1 UML Diagram
- 5.2.2 Notes
- 5.2.3 Data Dictionary
- 5.3 Debtor Account - Response
- 5.3.1 UML Diagram
- 5.3.2 Notes
- 5.3.3 Data Dictionary
- 5.1 Domestic Payment - Request
- 6 Usage Examples
- 6.1 Generic Flow
- 6.1.1 Sequence Diagram
- 6.1.2 Illustrative Interactions
- 6.2 Merchant
- 6.3 Person To Person
- 6.1 Generic Flow
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:
|
Definition
The domestic-payments resource represents single, domestic, electronic credit payment-orders made in NZD that has been initiated by a Third Party on behalf of a Customer. A domestic-payment must be initiated using a payment-order consent which has been previously authorised by a Customer with an API Provider. This payment-order consent may either be a short-lived (domestic-payment-consent) or long-lived (enduring-payment-consent) payment-order consent.
The Status of a domestic-payment represents the status of the payment initiation with the API Provider.
Endpoints
Resource | HTTP Operation | End-point | Mandatory ? | Scope | Grant Type | Idempotency Key | Request Object | Response Object |
|---|---|---|---|---|---|---|---|---|
domestic-payments | POST | POST /domestic-payments | Mandatory | payments | Redirect Flow; or Decoupled Flow | Yes | NZWriteDomestic1 | NZWriteDomesticResponse1 |