Versions Compared

Key

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

...

If the ReadPAN permission is granted by the user/customer, the ASPSP may choose to populate the OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Identification with the unmasked PAN (if the PAN is being populated in the response).

4.1.6 Data Dictionary

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBReadStandingOrder

 

OBReadStandingOrder

 

OBReadStandingOrder

 

 

Data

1..1

OBReadStandingOrder/Data

 

OBReadStandingOrder/Data

 

 

StandingOrder

0..n

OBReadStandingOrder/Data/StandingOrder

 

OBReadStandingOrder/Data/StandingOrder

 

 

AccountId

1..1

OBReadStandingOrder/Data/StandingOrder/AccountId

A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner

String

 

 

StandingOrderId

0..1

OBReadStandingOrder/Data/StandingOrder/StandingOrderId

A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner

String

 

 

Frequency

1..1

OBReadStandingOrder/Data/StandingOrder/Frequency

Individual Definitions:
NotKnown - Not known
EvryDay - Every day
EvryWorkgDay - Every working day
IntrvlDay - An interval specified in number of calendar days (02 to 31)
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 (-05 to -01, 01 to 31)
QtrDay - Quarterly (ENGLISH)
ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.

Individual Patterns:
NotKnown (ScheduleCode)
EvryDay (ScheduleCode)
EvryWorkgDay (ScheduleCode)
IntrvlDay:NoOfDay (ScheduleCode + NoOfDay)
IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
QtrDay: + either (ENGLISH) ScheduleCode + QuarterDay

The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
NotKnown
EvryDay
EvryWorkgDay
IntrvlDay:((0[2-9])\|([1-2][0-9])\|3[0-1])
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])
QtrDay:(ENGLISH)
Full Regular Expression:
^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(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]))$|^(QtrDay:(ENGLISH))$

String

 

^(NotKnown)$|^(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]))$|^(QtrDay:(ENGLISH))$

Reference

0..1

OBReadStandingOrder/Data/StandingOrder/Reference

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification

String

 

 

FirstPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/FirstPaymentDateTime

The date on which the first payment for a Standing Order schedule will be made

DateTime

 

 

NextPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/NextPaymentDateTime


The date on which the next payment for a Standing Order schedule will be made

DateTime

 

 

LastPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentDateTime

The date on which the last (most recent) payment for a Standing Order schedule was made

DateTime

 

 

FinalPaymentDateTime

0..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentDateTime

The date on which the final payment for a Standing Order schedule will be made

DateTime

 

 

NumberOfPayments

0..1

OBReadStandingOrder/Data/StandingOrder/NumberOfPayments

Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date

String

 

 

StandingOrderStatusCode

0..1

OBReadStandingOrder/Data/StandingOrder/StandingOrderStatusCode

Specifies the status of the standing order in code form

String

Enum:

  • Active

  • Inactive

 

FirstPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/FirstPaymentAmount

The amount of the first Standing Order

OBReadStandingOrder/Data/StandingOrder/FirstPaymentAmount

 

 

Amount

1..1

OBReadStandingOrder/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

String

 

^\d{1,13}$\|^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/FirstPaymentAmount/Currency

A code allocated to 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"

String

 

^[A-Z]{3,3}$

NextPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmount

The amount of the next Standing Order

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmount

 

 

Amount

1..1

OBReadStandingOrder/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

String

 

^\d{1,13}$\|^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/NextPaymentAmount/Currency

A code allocated to 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"

String

 

^[A-Z]{3,3}$

LastPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmount

The amount of the last (most recent) Standing Order instruction

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmount

 

 

Amount

1..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmount/Amount

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

String

 

^\d{1,13}$\|^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/LastPaymentAmount/Currency

A code allocated to 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"

String

 

^[A-Z]{3,3}$

FinalPaymentAmount

0..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmount

The amount of the final Standing Order

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmount

 

 

Amount

1..1

OBReadStandingOrder/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

String

 

^\d{1,13}$\|^\d{1,13}\.\d{1,5}$

Currency

1..1

OBReadStandingOrder/Data/StandingOrder/FinalPaymentAmount/Currency

A code allocated to 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"

String

 

^[A-Z]{3,3}$

CreditorAgent

0..1

OBReadStandingOrder/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

OBReadStandingOrder/Data/StandingOrder/CreditorAgent

 

 

SchemeName

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list

String

Enum:

  • BH.OBF.BICFI

 

Identification

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAgent/Identification

Unique and unambiguous identification of the servicing institution

String

 

 

CreditorAccount

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount

Provides the details to identify the beneficiary account

OBReadStandingOrder/Data/StandingOrder/CreditorAccount

 

 

SchemeName

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list

String

Enum:

  • BH.OBF.IBAN

 

Identification

1..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Identification

Beneficiary account identification

String

 

 

Name

0..1

OBReadStandingOrder/Data/StandingOrder/CreditorAccount/Name

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP’s online channels. Note, the account name is not the product name or the nickname of the account

String

 

 

SupplementaryData

0..1

OBReadStandingOrder/Data/StandingOrder/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block

OBSupplementaryData

 

 

...