Versions Compared

Version Old Version 2 New Version Current
Changes made by

Matthew Bell

Gavin Wong

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contents

Table of Contents
outlinetrue

Version Control


Version
Date
Author
Comments
1.0.001 March 2019Payments NZ API Working GroupStanding Baseline specification for Standing Orders specificationResource

Endpoints

Endpoints for the resource - and available methods.


ResourceHTTP OperationEndpointMandatory?ScopeGrant TypeIdempotentParametersRequest ObjectResponse Object
1standing-ordersGETGET /accounts/{AccountId}/standing-ordersOptionalaccountsAuthorization Code


OBReadStandingOrder2
2standing-ordersGETGET /standing-ordersOptionalaccountsAuthorization Code
Pagination
OBReadStandingOrder2

GET /accounts/{AccountId}/standing-orders

A Third Party may retrieve the standing-order resource for a specific AccountId (which is retrieved in the call to GET /accounts).

GET /standing-orders

If an API Provider has implemented the bulk retrieval endpoints - a Third Party may optionally retrieve the standing-order resources in bulk.

This will retrieve the resources for all authorised accounts linked to the account-request.

Data Model

The OBReadStandingOrder2 object will be used for the call to: 

  • GET /accounts/{AccountId}/standing-orders
  • GET /standing-orders

Resource 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.

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 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 PSU:
    • 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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBReadStandingOrder2
OBReadStandingOrder2
OBReadStandingOrder2

Data1..1OBReadStandingOrder2/Data
OBReadDataStandingOrder2

StandingOrder0..nOBReadStandingOrder2/Data/StandingOrder
OBStandingOrder2

AccountId1..1OBReadStandingOrder2/Data/StandingOrder/AccountIdA unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.Max40Text

StandingOrderId0..1OBReadStandingOrder2/Data/StandingOrder/StandingOrderIdA unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.Max40Text

Frequency1..1OBReadStandingOrder2/Data/StandingOrder/FrequencyIndividual Definitions:
EvryDay - Every day
EvryWorkgDay - Every working day
IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)
IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)

Individual Patterns:
EvryDay (ScheduleCode)
EvryWorkgDay (ScheduleCode)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)

The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
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])

Full Regular Expression:
^(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]))$		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]))$
StandingOrderStatusCode0..1OBReadStandingOrder2/Data/StandingOrder/StandingOrderStatusCodeSpecifies the status of the standing order in code form.OBExternalStandingOrderStatus1CodeActive
Inactive
FirstPaymentDateTime0..1OBReadStandingOrder2/Data/StandingOrder/FirstPaymentDateTimeThe date on which the first payment for a Standing Order schedule will be made.ISODateTime

NextPaymentDateTime1..1OBReadStandingOrder2/Data/StandingOrder/NextPaymentDateTimeThe date on which the next payment for a Standing Order schedule will be made.ISODateTime

FinalPaymentDateTime0..1OBReadStandingOrder2/Data/StandingOrder/FinalPaymentDateTimeThe date on which the final payment for a Standing Order schedule will be made.ISODateTime

Reference0..1OBReadStandingOrder2/Data/StandingOrder/ReferenceRemittance information for use with BECSElectronicCredit payment scheme.NZBECSRemittance1

CreditorName1..1OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorNameThe Creditor's Name.Max20Text

DebtorName0..1OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorNameThe Debtor's Name.Max20Text

CreditorReference0..1OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReferenceInformation 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

Particulars0..1OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference/ParticularsReference information, as assigned by the debtor, which when combined with Code and Reference, unambiguously refer to the payment transaction.Max12Text

Code0..1OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference/CodeReference information, as assigned by the debtor, which when combined with Particulars and Reference, unambiguously refer to the payment transaction.Max12Text

Reference0..1OBReadStandingOrder2/Data/StandingOrder/Reference/CreditorReference/ReferenceReference information, as assigned by the debtor, which when combined with Particulars and Code, unambiguously refer to the payment transaction.Max12Text

DebtorReference0..1OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReferenceInformation 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

Particulars0..1OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference/ParticularsReference information, as assigned by the debtor, which when combined with Code and Reference, unambiguously refer to the payment transaction.Max12Text

Code0..1OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference/CodeReference information, as assigned by the debtor, which when combined with Particulars and Reference, unambiguously refer to the payment transaction.Max12Text

Reference0..1OBReadStandingOrder2/Data/StandingOrder/Reference/DebtorReference/ReferenceReference information, as assigned by the debtor, which when combined with Particulars and Code, unambiguously refer to the payment transaction.Max12Text

FirstPaymentAmount0..1OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmountThe amount of the first Standing Order.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmount/AmountA 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}$
Currency1..1OBReadStandingOrder2/Data/StandingOrder/FirstPaymentAmount/CurrencyA 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}$
NextPaymentAmount1..1OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmountThe amount of the next Standing Order.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmount/AmountA 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}$
Currency1..1OBReadStandingOrder2/Data/StandingOrder/NextPaymentAmount/CurrencyA 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}$
FinalPaymentAmount0..1OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmountThe amount of the final Standing Order.OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmount/AmountA 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}$
Currency1..1OBReadStandingOrder2/Data/StandingOrder/FinalPaymentAmount/CurrencyA 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}$
CreditorAgent0..1OBReadStandingOrder2/Data/StandingOrder/CreditorAgentParty 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.
This is the servicer of the beneficiary account.		OBBranchAndFinancialInstitutionIdentification2

SchemeName1..1OBReadStandingOrder2/Data/StandingOrder/CreditorAgent/SchemeNameName of the identification scheme, in a coded form as published in an external list.OBExternalFinancialInstitutionIdentification2CodeBICFI
Identification1..1OBReadStandingOrder2/Data/StandingOrder/CreditorAgent/IdentificationUnique and unambiguous identification of the servicing institution.Max35Text

CreditorAccount0..1OBReadStandingOrder2/Data/StandingOrder/CreditorAccountProvides the details to identify the beneficiary account.OBCashAccount1

SchemeName1..1OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/SchemeNameName of the identification scheme, in a coded form as published in an external list.OBExternalAccountIdentification2CodeBECSElectronicCredit
Identification1..1OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/IdentificationBeneficiary account identification.Max34Text

Name0..1OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/NameName 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.

Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.		Max70Text

SecondaryIdentification0..1OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/SecondaryIdentificationThis is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).		Max34Text

Enumerations

This section gives the definitions for enumerations used.

Code ClassName Definition 
OBExternalAccountIdentification2CodeBECSElectronicCreditBECS Electronic Credit - identifier scheme used in  NZ by financial institutions to identify the account of a customer. The identifier is bank-branch-account-suffix.
The regular expression for this identifier is: ^[0-9]{2}-[0-9]{4}-[0-9]{7}-[0-9]{2}$
OBExternalStandingOrderStatus1CodeActiveThe standing order is active.
OBExternalStandingOrderStatus1CodeInactiveThe standing order is inactive.
OBExternalFinancialInstitutionIdentification2CodeBICFIValid 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



Request

Code Block
languagejs
themeMidnight
titleGet Accounts Standing Orders Request
linenumberstrue
GET /accounts/22289/standing-orders HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  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

Code Block
languagejs
themeMidnight
titleGet Accounts Standing Orders Response
linenumberstrue
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/v1.0/accounts/22289/standing-orders/"
  },
  "Meta": {
    "TotalPages": 1
  }
}


Bulk

Request

Code Block
languagejs
themeMidnight
titleGet Standing Orders Request
linenumberstrue
GET /standing-orders HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  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

Code Block
languagejs
themeMidnight
titleGet Standing Orders Response
linenumberstrue
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/v1.0/standing-orders/"
  },
  "Meta": {
    "TotalPages": 1
  }
}