Version Control
Version | Date | Author | Comments |
---|---|---|---|
2.0.0 | Payments NZ API Working Group | Baseline | |
2.1-draft1 |
| Updated:
Removed:
| |
2.1-rc2 | Updated:
| ||
2.2-draft1 | Updated:
| ||
2.2.1 | Patch update to Swagger specification to BECSRemittance - DebtorReference and CreditorReference - specify | ||
2.2.2 |
| Patch update to Swagger to reflect /wiki/spaces/PaymentsDirectionAPIStandardsDevelopment/pages/1455358006, which determined that the standard error response body should be included in all non-success HTTP responses. | |
2.2.3 |
| Patch update to clarify the explanation of BookingDateTime:
was replaced with:
|
Definition
A resource that contains a set of elements that describes the list of standing-orders that have been set up on a specific account (AccountId).
An account (AccountId) may have no standing-orders set up, or may have multiple standing-orders set up.
Endpoints
Resource | Endpoint | Mandatory? | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object |
---|---|---|---|---|---|---|---|---|
standing-orders | GET /accounts/{AccountId}/standing-orders | Optional | accounts | Redirect Flow; or Decoupled Flow | No | OBReadStandingOrder2 | ||
standing-orders | GET /standing-orders | Optional | accounts | Redirect Flow; or Decoupled Flow | No | Pagination | OBReadStandingOrder2 |
GET /accounts/{AccountId}/standing-orders
The API endpoint allows a Third Party to retrieve the standing-orders for a specific account identified by AccountId.
The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).
GET /standing-orders
The API endpoint allows a Third Party to retrieve standing-orders in bulk, if an API Provider has implemented the bulk retrieval endpoints.
The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow).
This will retrieve the standing-orders for all accounts linked to the account-access-consent.
Data Model
The OBReadStandingOrder2 object will be used for the call to:
GET /accounts/{AccountId}/standing-orders
GET /standing-orders
UML Diagram
Notes:
The Account and Creditor blocks replicate what is used consistently throughout the Account Information APIs to identify an account.
For the /accounts/{AccountId}/standing-orders endpoint - the Account and Creditor blocks represent the account that is receiving funds (so has been named the CreditorAccount - for consistency with the Payment Initiation use case).
A DateTime element has been used - so that there is consistency across all API endpoints using dates. Where time elements do not exist in API Provider systems - the time portion of the DateTime element will be defaulted to 00:00:00+00:00
The Amount elements all have embedded Currency elements - for consistency is ISO 20022, and across the other API endpoints
Permission Codes
The resource response differs depending on the permissions (ReadStandingOrdersBasic and ReadStandingOrdersDetail) used to access resource. In the event the resource is accessed with both ReadStandingOrdersBasic and ReadStandingOrdersDetail, the most detailed level (ReadStandingOrdersDetail) must be used.
These objects must not be returned without the ReadStandingOrdersDetail permission:
OBReadStandingOrder2/Data/StandingOrder/CreditorAgent
OBReadStandingOrder2/Data/StandingOrder/CreditorAccount
If the ReadStandingOrdersDetail is granted by the Customer:
OBReadStandingOrder2/Data/StandingOrder/CreditorAgent may be returned if applicable to the account and API Provider (0..1)
OBReadStandingOrder2/Data/StandingOrder/CreditorAccount must be returned (1..1)
Data Dictionary
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes |
---|---|---|---|---|---|
OBReadStandingOrder2 | OBReadStandingOrder2 | OBReadStandingOrder2 | |||
Data | 1..1 | OBReadStandingOrder2/Data | OBReadDataStandingOrder2 | ||
StandingOrder | 0..n | OBReadStandingOrder2/Data/StandingOrder | OBStandingOrder2 | ||
AccountId | 1..1 | OBReadStandingOrder2/Data/StandingOrder/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | Max40Text | |
StandingOrderId | 0..1 | OBReadStandingOrder2/Data/StandingOrder/StandingOrderId | A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner. | Max40Text | |
Frequency | 1..1 | OBReadStandingOrder2/Data/StandingOrder/Frequency | Individual Definitions: | Max35Text | ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$ |
StandingOrderStatusCode | 0..1 | OBReadStandingOrder2/Data/StandingOrder/StandingOrderStatusCode | Specifies the status of the standing order in code form. | OBExternalStandingOrderStatus1Code | Active |
FirstPaymentDateTime | 0..1 | OBReadStandingOrder2/Data/StandingOrder/FirstPaymentDateTime | The date on which the first payment for a Standing Order schedule will be made. | ISODateTime | |
NextPaymentDateTime | 1..1 | OBReadStandingOrder2/Data/StandingOrder/NextPaymentDateTime | The date on which the next payment for a Standing Order schedule will be made. | ISODateTime | |
FinalPaymentDateTime | 0..1 | OBReadStandingOrder2/Data/StandingOrder/FinalPaymentDateTime | The date on which the final payment for a Standing Order schedule will be made. | ISODateTime | |
Reference | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference | Remittance information for use with BECSElectronicCredit payment scheme. | NZBECSRemittance1 | |
CreditorName | 1..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorName | The Creditor's Name. | Max20Text | |
DebtorName | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorName | The Debtor's Name. | Max20Text | |
CreditorReference | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference | Information supplied to enable the reconciling of the payment with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. | NZBECSReference1 | |
Particulars | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference/Particulars | Reference information, as assigned by the debtor, which when combined with Code and Reference, unambiguously refer to the payment transaction. | Max12Text | |
Code | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference/Code | Reference information, as assigned by the debtor, which when combined with Particulars and Reference, unambiguously refer to the payment transaction. | Max12Text | |
Reference | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference/Reference | Reference information, as assigned by the debtor, which when combined with Particulars and Code, unambiguously refer to the payment transaction. | Max12Text | |
DebtorReference | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference | Information supplied to enable the reconciling of the payment with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. | NZBECSReference1 | |
Particulars | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference/Particulars | Reference information, as assigned by the debtor, which when combined with Code and Reference, unambiguously refer to the payment transaction. | Max12Text | |
Code | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference/Code | Reference information, as assigned by the debtor, which when combined with Particulars and Reference, unambiguously refer to the payment transaction. | Max12Text | |
Reference | 0..1 | OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference/Reference | Reference information, as assigned by the debtor, which when combined with Particulars and Code, unambiguously refer to the payment transaction. | Max12Text | |
FirstPaymentAmount | 0..1 | OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmount | The amount of the first Standing Order. | OBActiveOrHistoricCurrencyAndAmount | |
Amount | 1..1 | OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | ActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ |
NextPaymentAmount | 1..1 | OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmount | The amount of the next Standing Order. | OBActiveOrHistoricCurrencyAndAmount | |
Amount | 1..1 | OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | ActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ |
FinalPaymentAmount | 0..1 | OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmount | The amount of the final Standing Order. | OBActiveOrHistoricCurrencyAndAmount | |
Amount | 1..1 | OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | ActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ |
CreditorAgent | 0..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAgent | Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. | OBBranchAndFinancialInstitutionIdentification2 | |
SchemeName | 1..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalFinancialInstitutionIdentification2Code | BICFI |
Identification | 1..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAgent/Identification | Unique and unambiguous identification of the servicing institution. | Max35Text | |
CreditorAccount | 0..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAccount | Provides the details to identify the beneficiary account. | OBCashAccount1 | |
SchemeName | 1..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalAccountIdentification3Code | BECSElectronicCredit MaskedCardNumber |
Identification | 1..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/Identification | Beneficiary account identification. | Max34Text | |
Name | 0..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/Name | Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. | Max70Text | |
SecondaryIdentification | 0..1 | OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. | Max34Text |
Enumerations
This section gives the definitions for enumerations used.
Code Class | Name | Definition |
---|---|---|
OBExternalAccountIdentification3Code | BECSElectronicCredit | BECS Electronic Credit - identifier scheme used in NZ by financial institutions to identify the account of a customer. The identifier is bank-branch-account-suffix. |
OBExternalAccountIdentification3Code | MaskedCardNumber | Masked credit card number. This masked credit card number is the card identification number exactly as it is presented to the Customer in the API Provider’s online portal. |
OBExternalStandingOrderStatus1Code | Active | The standing order is active. |
OBExternalStandingOrderStatus1Code | Inactive | The standing order is inactive. |
OBExternalFinancialInstitutionIdentification2Code | BICFI | Valid BICs for financial institutions are registered by the ISO 9362 Registration Authority in the BIC directory, and consist of eight (8) or eleven (11) contiguous characters. |
Usage Examples
Specific Account
Retrieving standing-orders for a specific account.
Request
Get Accounts Standing Orders Request
GET /accounts/22289/standing-orders HTTP/1.1 Authorization: Bearer Az90SAOJklae x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json
Response
Get Accounts Standing Orders Response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "StandingOrder": [ { "AccountId": "22289", "StandingOrderId": "Ben3", "Frequency": "EvryWorkgDay", "Reference": { "CreditorName": "Towbar Club", "CreditorReference": { "Particulars": "CreditorPart", "Code": "CreditorCode", "Reference": "CreditorRef" }, "DebtorName": "The Debtor", "DebtorReference": { "Particulars": "DebtorPart", "Code": "DebtorCode", "Reference": "DebtorRef" } }, "FirstPaymentDateTime": "2017-08-12T00:00:00+00:00", "FirstPaymentAmount": { "Amount": "0.57", "Currency": "NZD" }, "NextPaymentDateTime": "2017-08-13T00:00:00+00:00", "NextPaymentAmount": { "Amount": "0.56", "Currency": "NZD" }, "FinalPaymentDateTime": "2027-08-12T00:00:00+00:00", "FinalPaymentAmount": { "Amount": "0.56", "Currency": "NZD" }, "StandingOrderStatusCode": "Active", "CreditorAccount": { "SchemeName": "BECSElectronicCredit", "Identification": "01-0101-0123456-00", "Name": "Mrs Juniper" } } ] }, "Links": { "Self": "https://api.examplebank.co.nz/open-banking-nz/v2.1/accounts/22289/standing-orders" }, "Meta": { "TotalPages": 1 } }
Bulk
Retrieving standing-orders for all accounts linked to the account-access-consent.
Request
Get Standing Orders Request
GET /standing-orders HTTP/1.1 Authorization: Bearer Az90SAOJklae x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json
Response
Get Standing Orders Response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "StandingOrder": [ { "AccountId": "22289", "StandingOrderId": "Ben3", "Frequency": "EvryWorkgDay", "Reference": { "CreditorName": "Towbar Club", "CreditorReference": { "Particulars": "CreditorPart", "Code": "CreditorCode", "Reference": "CreditorRef" }, "DebtorName": "The Debtor", "DebtorReference": { "Particulars": "DebtorPart", "Code": "DebtorCode", "Reference": "DebtorRef" } }, "FirstPaymentDateTime": "2017-08-12T00:00:00+00:00", "FirstPaymentAmount": { "Amount": "0.57", "Currency": "NZD" }, "NextPaymentDateTime": "2017-08-13T00:00:00+00:00", "NextPaymentAmount": { "Amount": "0.56", "Currency": "NZD" }, "FinalPaymentDateTime": "2027-08-12T00:00:00+00:00", "FinalPaymentAmount": { "Amount": "0.56", "Currency": "NZD" }, "StandingOrderStatusCode": "Active", "CreditorAccount": { "SchemeName": "BECSElectronicCredit", "Identification": "01-0101-0123456-00", "Name": "Mrs Juniper" } }, { "AccountId": "22289", "StandingOrderId": "Ben5", "Frequency": "WkinMnthDay(2)", "Reference": { "CreditorName": "Golf", "CreditorReference": { "Particulars": "CreditorPart", "Code": "CreditorCode", "Reference": "CreditorRef" }, "DebtorName": "The Debtor", "DebtorReference": { "Particulars": "DebtorPart", "Code": "DebtorCode", "Reference": "DebtorRef" } }, "FirstPaymentDateTime": "2017-06-12T00:00:00+00:00", "FirstPaymentAmount": { "Amount": "23.00", "Currency": "NZD" }, "NextPaymentDateTime": "2017-07-12T00:00:00+00:00", "NextPaymentAmount": { "Amount": "23.00", "Currency": "NZD" }, "FinalPaymentDateTime": "2018-06-12T00:00:00+00:00", "FinalPaymentAmount": { "Amount": "23.00", "Currency": "NZD" }, "StandingOrderStatusCode": "Active", "CreditorAccount": { "SchemeName": "BECSElectronicCredit", "Identification": "02-0202-0232454-00", "Name": "Mr Tee" } } ] }, "Links": { "Self": "https://api.examplebank.co.nz/open-banking-nz/v2.1/standing-orders" }, "Meta": { "TotalPages": 1 } }