Versions Compared

Key

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

...

  • OBReadTransaction/Data/Transaction/CreditorAccount/Identification

  • OBReadTransaction/Data/Transaction/DebtorAccount/Identification

  • OBReadTransaction/Data/Transaction/CardInstrument/Identification

4.1.6 Data Dictionary

EnhancedDefinition

Name

Occurrence

XPath

Enhanced Definition

Class/ Datatype

Codes

Pattern

OBReadTransaction

 

OBReadTransaction

 

OBReadTransaction

 

 

Data

1..1

OBReadTransaction/Data

 

OBReadTransaction/Data

 

 

Transaction

0..n

OBReadTransaction/Data/Transaction

Provides further details on an entry in the report

OBReadTransaction/Data/Transaction

 

 

AccountId

1..1

OBReadTransaction/Data/Transaction/AccountId

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

String

 

 

TransactionId

0..1

OBReadTransaction/Data/Transaction/TransactionId

Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable

String

 

 

TransactionReference

0..1

OBReadTransaction/Data/Transaction/TransactionReference

Unique reference for the transaction. This reference is optionally populated

String

 

 

StatementReference

0..n

OBReadTransaction/Data/Transaction/StatementReference

Unique reference for the statement. This reference may be optionally populated if available

String

 

 

CreditDebitIndicator

1..1

OBReadTransaction/Data/Transaction/CreditDebitIndicator

Indicates whether the transaction is a credit or a debit entry

String

Enum:

  • Credit

  • Debit

 

Status

1..1

OBReadTransaction/Data/Transaction/Status

Status of a transaction entry on the books of the account servicer

String

Enum:

  • Booked

  • Pending

  • Interimpending

 

BookingDateTime

1..1

OBReadTransaction/Data/Transaction/BookingDateTime

Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date

DateTime

 

 

ValueDateTime

0..1

OBReadTransaction/Data/Transaction/ValueDateTime

Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of available days

DateTime

 

 

TransactionInformation

0..1

OBReadTransaction/Data/Transaction/TransactionInformation

Further details of the transaction. This is the transaction narrative, which is unstructured text

String

 

 

AddressLine

0..1

OBReadTransaction/Data/Transaction/AddressLine

Information that locates and identifies a specific address for a transaction entry that is presented in free format text

String

 

 

Amount

1..1

OBReadTransaction/Data/Transaction/Amount

Amount of money in the cash transaction entry

OBReadTransaction/Data/Transaction/Amount

 

 

Amount

1..1

OBReadTransaction/Data/Transaction/Amount/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

OBReadTransaction/Data/Transaction/Amount/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"

String

 

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

ChargeAmount

0..1

OBReadTransaction/Data/Transaction/ChargeAmount

Transaction charges to be paid by the charge bearer

OBReadTransaction/Data/Transaction/ChargeAmount

 

 

Amount

1..1

OBReadTransaction/Data/Transaction/ChargeAmount/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

OBReadTransaction/Data/Transaction/ChargeAmount/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"

String

 

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

CurrencyExchange

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange

Set of elements used to provide details on the currency exchange

OBReadTransaction/Data/Transaction/CurrencyExchange

 

 

SourceCurrency

1..1

OBReadTransaction/Data/Transaction/CurrencyExchange/SourceCurrency

Currency from which an amount is to be converted in a currency conversion

String

 

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

TargetCurrency

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/TargetCurrency

Currency into which an amount is to be converted in a currency conversion

String

 

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

UnitCurrency

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/UnitCurrency

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1BHD = xxxCUR, the unit currency is BHD

String

 

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

ExchangeRate

1..1

OBReadTransaction/Data/Transaction/CurrencyExchange/ExchangeRate

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency)

Number

 

 

ContractIdentification

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/ContractIdentification

Unique identification to unambiguously identify the foreign exchange contract

String

 

 

QuotationDate

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/QuotationDate

Date and time at which an exchange rate is quoted

 DateTime

 

 

InstructedAmount

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/InstructedAmount

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party

OBReadTransaction/Data/Transaction/CurrencyExchange/InstructedAmount

 

 

Amount

1..1

OBReadTransaction/Data/Transaction/CurrencyExchange/InstructedAmount/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

OBReadTransaction/Data/Transaction/CurrencyExchange/InstructedAmount/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"

String

 

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

BankTransactionCode

0..1

OBReadTransaction/Data/Transaction/BankTransactionCode

Set of elements used to fully identify the type of underlying transaction resulting in an entry

OBReadTransaction/Data/Transaction/BankTransactionCode

 

 

Code

1..1

OBReadTransaction/Data/Transaction/BankTransactionCode/Code

Specifies the family within a domain

String

 

 

SubCode

1..1

OBReadTransaction/Data/Transaction/BankTransactionCode/SubCode

Specifies the sub-product family within a specific family

String

 

 

ProprietaryBankTransactionCode

0..1

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCode

Set of elements to fully identify a proprietary bank transaction code

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCode

 

 

Code

1..1

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCode/Code

Proprietary bank transaction code to identify the underlying transaction

String

 

 

Issuer

0..1

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCode/Issuer

Identification of the issuer of the proprietary bank transaction code

String

 

 

Balance

0..1

OBReadTransaction/Data/Transaction/Balance

Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account

OBReadTransaction/Data/Transaction/Balance

 

 

CreditDebitIndicator

1..1

OBReadTransaction/Data/Transaction/Balance/CreditDebitIndicator

Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance

String

Enum:

  • Credit

  • Debit

 

Type

1..1

OBReadTransaction/Data/Transaction/Balance/Type

Balance type, in a coded form

String

Enum:

  • ClosingAvailable

  • ClosingBooked

  • ClosingCleared

  • Expected

  • ForwardAvailable

  • Information

  • InterimAvailable

  • InterimBooked

  • InterimCleared

  • OpeningAvailable

  • OpeningBooked

  • OpeningCleared

  • PreviouslyClosedBooked

 

Amount

1..1

OBReadTransaction/Data/Transaction/Balance/Amount

Amount of money of the cash balance after a transaction entry is applied to the account

OBReadTransaction/Data/Transaction/Balance/Amount

 

 

Amount

1..1

OBReadTransaction/Data/Transaction/Balance/Amount/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

OBReadTransaction/Data/Transaction/Balance/Amount/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"

String

 

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

MerchantDetails

0..1

OBReadTransaction/Data/Transaction/MerchantDetails

Details of the merchant involved in the transaction

OBReadTransaction/Data/Transaction/MerchantDetails

 

 

MerchantName

0..1

OBReadTransaction/Data/Transaction/MerchantDetails/MerchantName

Name by which the merchant is known

String

 

 

MerchantCategoryCode

0..1

OBReadTransaction/Data/Transaction/MerchantDetails/MerchantCategoryCode

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction

String

 

 

CreditorAgent

0..1

OBReadTransaction/Data/Transaction/CreditorAgent

Financial institution servicing an account for the creditor

OBReadTransaction/Data/Transaction/CreditorAgent

 

 

SchemeName

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/SchemeName

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

String

Enum: 

  • BH.OBF.BICFI

 

Identification

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution

String

 

 

Name

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent

String

 

 

PostalAddress

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress

 

 

AddressType

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address

String

Enum:

  • Business

  • Correspondence

  • DeliveryTo

  • MailTo

  • POBox

  • Postal

  • Residential

  • Statement

 

Department

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building

String

 

 

SubDepartment

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building

String

 

 

AddressLine

0..7

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text

String

StreetName

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/StreetName

Number of a street or thoroughfare

String

 

 

BuildingNumber

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street

String

PostCode

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

String

TownName

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government

String

CountrySubDivision

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region and county

String

Country

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/Country

Nation with its own government

String

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

CreditorAccount

0..1

OBReadTransaction/Data/Transaction/CreditorAccount

Unambiguous identification of the account of the creditor, in the case of a debit transaction

OBReadTransaction/Data/Transaction/CreditorAccount

 

 

SchemeName

0..1

OBReadTransaction/Data/Transaction/CreditorAccount/SchemeName

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

String

Enum:

  • BH.OBF.IBAN

 

Identification

0..1

OBReadTransaction/Data/Transaction/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner

String

 

 

Name

0..1

OBReadTransaction/Data/Transaction/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

 

 

DebtorAgent

0..1

OBReadTransaction/Data/Transaction/DebtorAgent

Financial institution servicing an account for the debtor

OBReadTransaction/Data/Transaction/DebtorAgent

 

 

SchemeName

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/SchemeName

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

String

Enum:

  • BH.OBF.BICFI

 

Identification

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution

String

 

 

Name

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/Name

Name by which an agent is known and which is usually used to identify that agent

String

 

 

PostalAddress

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress

 

 

AddressType

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/AddressType

Identifies the nature of the postal address

String

Enum:

  • Business

  • Correspondence

  • DeliveryTo

  • MailTo

  • POBox

  • Postal

  • Residential

  • Statement

 

Department

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/Department

Identification of a division of a large organisation or building

String

 

 

SubDepartment

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building

String

 

 

AddressLine

0..7

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text

String

StreetName

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/StreetName

Number of a street or thoroughfare

String

BuildingNumber

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street

String

 

 

PostCode

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/PostCode

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

String

TownName

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government

String

CountrySubDivision

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, and county

String

 

 

Country

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/Country

Nation with its own government

String

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

DebtorAccount

0..1

OBReadTransaction/Data/Transaction/DebtorAccount

Unambiguous identification of the account of the debtor, in the case of a credit transaction

OBReadTransaction/Data/Transaction/DebtorAccount

 

 

SchemeName

0..1

OBReadTransaction/Data/Transaction/DebtorAccount/SchemeName

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

String

Enum:

  • BH.OBF.IBAN

 

Identification

0..1

OBReadTransaction/Data/Transaction/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner

String

 

 

Name

0..1

OBReadTransaction/Data/Transaction/DebtorAccount/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

 

 

CardInstrument

0..1

OBReadTransaction/Data/Transaction/CardInstrument

Set of elements to describe the card instrument used in the transaction

OBReadTransaction/Data/Transaction/CardInstrument

 

 

CardSchemeName

1..1

OBReadTransaction/Data/Transaction/CardInstrument/CardSchemeName

Name of the card scheme

String

Enum: (Indicative)

  • AmericanExpress

  • Diners

  • JCB

  • MasterCard

  • VISA

 

AuthorisationType

0..1

OBReadTransaction/Data/Transaction/CardInstrument/AuthorisationType

The card authorisation type

String

Enum:

  • ConsumerDevice

  • Contactless

  • None

  • PIN

 

Name

0..1

OBReadTransaction/Data/Transaction/CardInstrument/Name

Name of the cardholder using the card instrument

String

 

 

Identification

0..1

OBReadTransaction/Data/Transaction/CardInstrument/Identification

Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked

String

 

 

...