2.0.0

Apr 30, 2020

Payments NZ API Working Group

Baseline specification for Beneficiaries resource

2.1-draft1

Jun 15, 2020  

@Gavin Wong (Unlicensed)

Updated:

• Added MaskedCardNumber as new SchemeName enumeration for the account identification object in data dictionary as per https://paymentsnz.atlassian.net/wiki/spaces/PaymentsDirectionAPIStandardsDevelopment/pages/361955329 and https://paymentsnz.atlassian.net/wiki/spaces/PaymentsDirectionAPIStandardsDevelopment/pages/362020869

• Definition of MaskedCardNumber

• Usage Example version from v2.0 to v2.1

Removed:

• ReadPAN permission as per https://paymentsnz.atlassian.net/wiki/spaces/PaymentsDirectionAPIStandardsDevelopment/pages/361922594

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

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:
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]))$

StandingOrderStatusCode

0..1

OBReadStandingOrder2/Data/StandingOrder/StandingOrderStatusCode

Specifies the status of the standing order in code form.

OBExternalStandingOrderStatus1Code

Active
Inactive

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.
This is the servicer of the beneficiary 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.

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

SecondaryIdentification

0..1

OBReadStandingOrder2/Data/StandingOrder/CreditorAccount/SecondaryIdentification

This 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

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.
The regular expression for this identifier is: ^[0-9]{2}-[0-9]{4}-[0-9]{7}-[0-9]{2}$

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.