Version

Date

Description of Changes

Bahrain OBF v1.0.0

25th Aug 2020

Initial Release

S. No.

Resource

HTTP Operation

Endpoint

Mandatory

Scope

Grant Type

Idempotency Key

Parameters

Request Object

Response Object

23.1

transactions

GET

GET/accounts/{AccountsIdAccountId}/transactions

Mandatory

accounts

Authorisation Code

No

Pagination filtering

OBReadTransaction

23.2

transactions

GET

GET/transactions

_optionalOptional

accounts

Authorisation Code

No

Pagination filtering

OBReadTransaction

Name

Occurrence

Enhanced Definition

Class

fromBookingDateTime

0..1

Specifies start date and time for filtering of the Transaction records on the Transaction/BookingDateTime field

DateTime

toBookingDateTime

0..1

Specifies end date and time for filtering of the Transaction records on the Transaction/BookingDateTime field.

DateTime

// Mutable

{  "Status": "Booked",

  "TransactionMutability": "Mutable"   }

// Immutable

{  "Status": "Booked",

  "TransactionMutability": "Immutable" }

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

_{OBReadTransaction/Data}

 /Transaction/Status

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

String

Enum:

• Booked

• Pending

• Interimpending

_TransactionBookingDateTime

01..n1

OBReadTransaction/Data/Transaction

_{Provides further details on an entry in the report.}

_{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

_AccountIdValueDateTime

10..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/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

_{TransactionId}TransactionInformation

0..1

OBReadTransaction/Data/Transaction/TransactionIdUnique identifier for TransactionInformation

Further details of the transaction within an servicing institution. This identifier is both unique and immutable.is the transaction narrative, which is unstructured text

String

_{TransactionReference}AddressLine

0..1

OBReadTransaction/Data/Transaction/TransactionReference_{Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.}AddressLine

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

String

_{StatementReference}Amount

01..n1

OBReadTransaction/Data/Transaction/StatementReference

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

_StringAmount

Amount of money in the cash transaction entry

OBReadTransaction/Data/Transaction/Amount

_{CreditDebitIndicator}Amount

1..1

OBReadTransaction/Data/Transaction/CreditDebitIndicator

_{Indicates whether the transaction is a credit or a debit entry.}

_String

_Enum:

• _Credit

• _Debit

_StatusAmount/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/Status

_{Status of a transaction entry on the books of the account servicer.}

_String

_Enum:

• _Booked

• _Pending

_{TransactionMutability}

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

_{Specifies the Mutability of the Transaction record.}

_String

_Enum:

• _Mutable

• _Immutable

_{BookingDateTime}ChargeAmount

Transaction charges to be paid by the charge bearer

OBReadTransaction/Data/Transaction/ChargeAmount

Amount

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}

0ChargeAmount/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/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 availability days.}

_DateTime

_{TransactionInformation}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/TransactionInformation_{Further details of the transaction. This is the transaction narrative, which is unstructured text.}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

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

TargetCurrency

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/AddressLine_{Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.}TargetCurrency

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

String

_Amount

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

UnitCurrency

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/Amount

_{Amount of money in the cash transaction entry.}

_{OBReadTransaction/Data/Transaction/Amount}

_AmountUnitCurrency

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

1ExchangeRate

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/AmountCurrencyExchange/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".}ContractIdentification

Unique identification to unambiguously identify the foreign exchange contract

String

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

_ChargeAmount 

QuotationDate

0..1

OBReadTransaction/Data/Transaction/ChargeAmount_{Transaction charges to be paid by the charge bearer.}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/ChargeAmountTransaction/CurrencyExchange/InstructedAmount

Amount

1..1

OBReadTransaction/Data/Transaction/CurrencyExchange/ChargeAmountInstructedAmount/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/ChargeAmountInstructedAmount/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}BankTransactionCode

0..1

OBReadTransaction/Data/Transaction/CurrencyExchangeBankTransactionCode

Set of elements used to provide details on the currency exchange.fully identify the type of underlying transaction resulting in an entry

OBReadTransaction/Data/Transaction/CurrencyExchangeBankTransactionCode

_{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

Code

1..1

OBReadTransaction/Data/Transaction/CurrencyExchangeBankTransactionCode/TargetCurrency_{Currency into which an amount is to be converted in a currency conversion.}Code

Specifies the family within a domain

String

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

_UnitCurrency

0 

SubCode

1..1

OBReadTransaction/Data/Transaction/CurrencyExchangeBankTransactionCode/UnitCurrencySubCode

_{Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.}

_String

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

_ExchangeRate

1Specifies the sub-product family within a specific family

String

ProprietaryBankTransactionCode

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

ProprietaryBankTransactionCode

Set of elements to fully identify a proprietary bank transaction code

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCode

_{ContractIdentification}Code

01..1

OBReadTransaction/Data/Transaction/CurrencyExchangeProprietaryBankTransactionCode/ContractIdentification_{Unique identification to unambiguously identify the foreign exchange contract.}Code

Proprietary bank transaction code to identify the underlying transaction

String

_{QuotationDate}Issuer

0..1

OBReadTransaction/Data/Transaction/CurrencyExchangeProprietaryBankTransactionCode/QuotationDate

_{Date and time at which an exchange rate is quoted.}

 _DateTimeIssuer

Identification of the issuer of the proprietary bank transaction code

String

_{InstructedAmount}Balance

0..1

OBReadTransaction/Data/Transaction/CurrencyExchange/InstructedAmountBalance

Amount Set of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.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/CurrencyExchange/InstructedAmountBalance

_AmountCreditDebitIndicator

1..1

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

_CurrencyCreditDebitIndicator

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/CurrencyExchangeBalance/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}

0Type

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

_{Set of elements used to fully identify the type of underlying transaction resulting in an entry.}Amount of money of the cash balance after a transaction entry is applied to the account

OBReadTransaction/Data/Transaction/Balance/BankTransactionCodeAmount

_CodeAmount

1..1

OBReadTransaction/Data/Transaction/BankTransactionCodeBalance/Amount/Code

_{Specifies the family within a domain.}

_String

_SubCode

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/BankTransactionCodeBalance/Amount/SubCode_{Specifies the sub-product family within a specific family.}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

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

MerchantDetails

0..1

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCodeMerchantDetails

_{Set of elements to fully identify a proprietary bank transaction code.}Details of the merchant involved in the transaction

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCodeMerchantDetails

_CodeMerchantName

10..1

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCodeMerchantDetails/Code_{Proprietary bank transaction code to identify the underlying transaction.}MerchantName

Name by which the merchant is known

String

_IssuerMerchantCategoryCode

0..1

OBReadTransaction/Data/Transaction/ProprietaryBankTransactionCodeMerchantDetails/Issuer_{Identification of the issuer of the proprietary bank transaction code.}MerchantCategoryCode

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

String

_BalanceCreditorAgent

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.}/Data/Transaction/CreditorAgent

Financial institution servicing an account for the creditor

OBReadTransaction/Data/Transaction/BalanceCreditorAgent

_{CreditDebitIndicator}SchemeName

10..1

OBReadTransaction/Data/Transaction/BalanceCreditorAgent/CreditDebitIndicatorSchemeName

_{Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.}Name of the identification scheme, in a coded form as published in an external list

String

Enum: 

• _Credit

• _Debit

• BH.OBF.BICFI

_TypeIdentification

10..1

OBReadTransaction/Data/Transaction/BalanceCreditorAgent/Type

_{Balance type, in a coded form.}

_String

_Enum:

• _{ClosingAvailable}

• _{ClosingBooked}

• _{ClosingCleared}

• _Expected

• _{ForwardAvailable}

• _Information

• _{InterimAvailable}

• _{InterimBooked}

• _{InterimCleared}

• _{OpeningAvailable}

• _{OpeningBooked}

• _{OpeningCleared}

• _{PreviouslyClosedBooked}

_Amount

1Identification

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

String

Name

0..1

OBReadTransaction/Data/Transaction/BalanceCreditorAgent/Amount

_{Amount of money of the cash balance after a transaction entry is applied to the account..}

_{OBReadTransaction/Data/Transaction/Balance/Amount}Name

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

String

_AmountPostalAddress

10..1

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

1PostalAddress

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

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress

AddressType

0..1

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

_MerchantNameAddressType

Identifies the nature of the postal address

String

Enum:

• Business

• Correspondence

• DeliveryTo

• MailTo

• POBox

• Postal

• Residential

• Statement

Department

0..1

OBReadTransaction/Data/Transaction/MerchantDetailsCreditorAgent/PostalAddress/MerchantName_{Name by which the merchant is known.}Department

Identification of a division of a large organisation or building

String

_{MerchantCategoryCode}SubDepartment

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/MerchantDetailsPostalAddress/MerchantCategoryCode_{Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.}SubDepartment

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

String

_{CreditorAgent}AddressLine

0..17

OBReadTransaction/Data/Transaction/CreditorAgent_{Financial institution servicing an account for the creditor.}/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

_SchemeNameBuildingNumber

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/SchemeName

_{Name of the identification scheme, in a coded form as published in an external list.}

_String

_Enum:

• _BH.OBF.IBAN

_{Identification}BuildingNumber

Number that identifies the position of a building on a street

String

PostCode

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/Identification

_{Unique and unambiguous identification of a financial institution or a branch of a financial institution.}

_String

_NamePostalAddress/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/Name

_{Name by which an agent is known and which is usually used to identify that agent.}

_String

_{PostalAddress}TownName

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

String

CountrySubDivision

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

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

String

Country

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

_DepartmentCountry

Nation with its own government

String

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

CreditorAccount

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/Department

_{Identification of a division of a large organisation or building.}

_StringCreditorAccount

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

OBReadTransaction/Data/Transaction/CreditorAccount

_{SubDepartment}SchemeName

0..1

OBReadTransaction/Data/Transaction/CreditorAgentCreditorAccount/PostalAddress/SubDepartmentSchemeName

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

_String

_AddressLinethe identification scheme, in a coded form as published in an external list

String

Enum:

• BH.OBF.IBAN

Identification

0..71

OBReadTransaction/Data/Transaction/CreditorAgentCreditorAccount/PostalAddress/AddressLine

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

_String

_StreetNameIdentification

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

String

Name

0..1

OBReadTransaction/Data/Transaction/CreditorAgentCreditorAccount/PostalAddress/StreetName_{Name of a street or thoroughfare.}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

_{BuildingNumber}DebtorAgent

0..1

OBReadTransaction/Data/Transaction/CreditorAgent/PostalAddress/BuildingNumber

_{Number that identifies the position of a building on a street.}

_String

_PostCode

_0..1

DebtorAgent

Financial institution servicing an account for the debtor

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

DebtorAgent

_TownNameSchemeName

0..1

OBReadTransaction/Data/Transaction/CreditorAgentDebtorAgent/PostalAddress/TownName

_{Name of a built-up area, with defined boundaries, and a local government.}

_String

_{CountrySubDivision}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/CreditorAgentDebtorAgent/PostalAddress/CountrySubDivision_{Identifies a subdivision of a country such as state, region, county.}Identification

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

String

_CountryName

0..1

OBReadTransaction/Data/Transaction/CreditorAgentDebtorAgent/PostalAddress/Country_{Nation with its own government.}Name

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

String

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

_{CreditorAccount} 

PostalAddress

0..1

OBReadTransaction/Data/Transaction/CreditorAccount_{Unambiguous identification of the account of the creditor, in the case of a debit transaction.}DebtorAgent/PostalAddress

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

OBReadTransaction/Data/Transaction/DebtorAgent/CreditorAccountPostalAddress

_SchemeNameAddressType

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/CreditorAccountPostalAddress/SchemeNameAddressType

_{Name of the identification scheme, in a coded form as published in an external list.}Identifies the nature of the postal address

String

 EnumEnum:

• _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

• Business

• Correspondence

• DeliveryTo

• MailTo

• POBox

• Postal

• Residential

• Statement

Department

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/CreditorAccountPostalAddress/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.}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

_DebtorAgentAddressLine

0..17

OBReadTransaction/Data/Transaction/DebtorAgent_{Financial institution servicing an account for the debtor.}/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/DebtorAgent

_SchemeNameStreetName

Number of a street or thoroughfare

String

BuildingNumber

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/SchemeName

_{Name of the identification scheme, in a coded form as published in an external list.}

_String

_Enum:

• _BH.OBF.IBAN

_{Identification}BuildingNumber

Number that identifies the position of a building on a street

String

PostCode

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/Identification

_{Unique and unambiguous identification of a financial institution or a branch of a financial institution.}

_String

_NamePostalAddress/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/Name

_{Name by which an agent is known and which is usually used to identify that agent.}

_String

_{PostalAddress}PostalAddress/TownName

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

String

CountrySubDivision

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}/CountrySubDivision

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

String

_AddressTypeCountry

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

_DepartmentCountry

Nation with its own government

String

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

DebtorAccount

0..1

OBReadTransaction/Data/Transaction/DebtorAgent/PostalAddress/Department

_{Identification of a division of a large organisation or building.}

_StringDebtorAccount

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

OBReadTransaction/Data/Transaction/DebtorAccount

_AddressLineSchemeName

0..71

OBReadTransaction/Data/Transaction/DebtorAgentDebtorAccount/PostalAddress/AddressLine

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

_String

_StreetNameSchemeName

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/DebtorAgentDebtorAccount/PostalAddress/StreetName_{Name of a street or thoroughfare.}Identification

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

String

_{BuildingNumber}Name

0..1

OBReadTransaction/Data/Transaction/DebtorAgentDebtorAccount/PostalAddress/BuildingNumber_{Number that identifies the position of a building on a street.}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

_PostCodeCardInstrument

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

_StringCardInstrument

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

OBReadTransaction/Data/Transaction/CardInstrument

_TownNameCardSchemeName

01..1

OBReadTransaction/Data/Transaction/DebtorAgentCardInstrument/PostalAddress/TownNameCardSchemeName

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

 _String

_{CountrySubDivision}Name of the card scheme

String

Enum: (Indicative)

• AmericanExpress

• Diners

• JCB

• MasterCard

• VISA

AuthorisationType

0..1

OBReadTransaction/Data/Transaction/DebtorAgentCardInstrument/PostalAddress/CountrySubDivision

_{Identifies a subdivision of a country such as state, region, county.}

_String

_CountryAuthorisationType

The card authorisation type

String

Enum:

• ConsumerDevice

• Contactless

• None

• PIN

Name

0..1

OBReadTransaction/Data/Transaction/DebtorAgentCardInstrument/PostalAddress/Country_{Nation with its own government.}Name

Name of the cardholder using the card instrument

String

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

_{DebtorAccount} 

Identification

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:

• _{AmericanExpress}

• _{Diners Discover}

• _{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

_{SupplementaryData}

_0..1

_{OBReadTransaction/Data/Transaction/SupplementaryData}

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

_{OBReadTransaction/Data/Transaction/SupplementaryData}

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

GET /accounts/00345897/transactions
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 24 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/json

200 OK
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "00345897",
        "TransactionId": "2257",
        "TransactionReference": "Transaction Ref",
        "StatementReference": [
          "Statement Ref"
        ],
        "CreditDebitIndicator": "Credit",
        "Status": "Booked",
        "BookingDateTime": "2020-03-24T06:03:00.348+03:00”,
        "ValueDateTime": "2020-03-24T06:03:00.348+03:00”,
        "Amount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "ChargeAmount": {
          "Amount": "50",
          "Currency": "BHD"
        },

        "CurrencyExchange": {
          "SourceCurrency": "BHD",
          "TargetCurrency": "BHD",
          "UnitCurrency": "BHD",
          "ExchangeRate": 0.44,
          "ContractIdentification": " ",
          "QuotationDate": "2020-03-24T06:03:00.348+03:00”,
          "InstructedAmount": {
            "Amount": "1000",
            "Currency": "BHD"
          }
        },
        "BankTransactionCode": {
          "Code": "ReceivedCreditTransfer",
          "SubCode": "CreditTransfer"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "Transfer",
          "Issuer": "XYZBank"
        },
        "CardInstrument": {
          "CardSchemeName": "XYZ",
          "AuthorisationType": "ConsumerDevice",
          "Name": "Ali Hassan Mohammed",
          "Identification": "BH10XYZU00100000008876"
        },
      },
    ]
  },
 "Links": {
    "Self": "www.TBC.com"
  },
  "Meta": {
    "TotalPages": 02,
    "FirstAvailableDateTime": "2020-03-24T09:10:17.596+03:00”,
    "LastAvailableDateTime": "2020-03-24T09:10:17.596+03:00”
  }

}

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "00345897",
        "TransactionId": "2257",
        "TransactionReference": "Transaction Ref",
        "StatementReference": [
          "Statement Ref"
        ],
        "CreditDebitIndicator": "Credit",
        "Status": "Booked",
        "BookingDateTime": "2020-03-24T06:03:00.348+03:00”,
        "ValueDateTime": "2020-03-24T06:03:00.348+03:00”,
        "Amount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "ChargeAmount": {
          "Amount": "50",
          "Currency": "BHD"
        },
        "CurrencyExchange": {
          "SourceCurrency": "BHD",
          "TargetCurrency": "BHD",
          "UnitCurrency": "BHD",
          "ExchangeRate": 0.44,
          "ContractIdentification": " ",
          "QuotationDate": "2020-03-24T06:03:00.348+03:00”,
          "InstructedAmount": {
            "Amount": "1000",
            "Currency": "BHD"
          }
        },

        "BankTransactionCode": {
          "Code": "ReceivedCreditTransfer",
          "SubCode": "CreditTransfer"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "Transfer",
          "Issuer": "XYZBank"
        },
        "CardInstrument": {
          "CardSchemeName": "AmericanExpressXYZ",
          "AuthorisationType": "ConsumerDevice",
          "Name": "Asif KhanAli Hassan Mohammed",
          "Identification": "BH10XYZU00100000008876"
        },
      },
      {
        "AccountId": "0012786",
        "TransactionId": "4532",
        "TransactionReference": "Transaction Ref",
        "StatementReference": [
          "Statement Ref"
        ],
        "CreditDebitIndicator": "Debit",
        "Status": "Booked",
        "BookingDateTime": "2020-03-24T06:03:00.348+03:00”,
        "ValueDateTime": "2020-03-24T06:03:00.348+03:00”,
        "Amount": {
          "Amount": "100",
          "Currency": "BHD"
        },
        "ChargeAmount": {
          "Amount": "10",
          "Currency": "BHD"
        },
        "CurrencyExchange": {
          "SourceCurrency": "BHD",
          "TargetCurrency": "BHD",
          "UnitCurrency": "BHD",
          "ExchangeRate": 2.65,
          "ContractIdentification": " ",
          "QuotationDate": "2020-03-24T06:03:00.348+03:00”,
          "InstructedAmount": {
            "Amount": "100",
            "Currency": "BHD"
          }
        },
        "BankTransactionCode": {
          "Code": "IssuedCreditTransfer",
          "SubCode": "AutomaticTransfer"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "DirectDebit",
          "Issuer": "XYZBank"
        },
        "CardInstrument": {
          "CardSchemeName": "AmericanExpressXYZ",
          "AuthorisationType": "ConsumerDevice",
          "Name": "Avin D'souza",
          "Identification": "BH10XYZU00100000008876"
        },
      }
    ]
  },
 "Links": {
    "Self": "www.TBC.com"
  },
  "Meta": {
    "TotalPages": 02,
    "FirstAvailableDateTime": "2020-03-24T09:10:17.596+03:00”,
    "LastAvailableDateTime": "2020-03-24T09:10:17.596+03:00”
  }

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "00345897",
        "TransactionId": "2257",
        "TransactionReference": "Transaction Ref",
        "StatementReference": [
          "Statement Ref"
        ],
        "CreditDebitIndicator": "Credit",
        "Status": "Booked",
        "BookingDateTime": "2020-03-24T06:03:00.348+03:00”,
        "ValueDateTime": "2020-03-24T06:03:00.348+03:00”,
        "Amount": {
          "Amount": "1000",
          "Currency": "BHD"
        },
        "ChargeAmount": {
          "Amount": "50",
          "Currency": "BHD"
        },
        "CurrencyExchange": {
          "SourceCurrency": "BHD",
          "TargetCurrency": "BHD",
          "UnitCurrency": "BHD",
          "ExchangeRate": 0.44,
          "ContractIdentification": " ",
          "QuotationDate": "2020-03-24T06:03:00.348+03:00”,
          "InstructedAmount": {
            "Amount": "1000",
            "Currency": "BHD"
          }
        },
        "BankTransactionCode": {
          "Code": "ReceivedCreditTransfer",
          "SubCode": "CreditTransfer"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "Transfer",
          "Issuer": "XYZBank"
        },
        "CardInstrument": {
          "CardSchemeName": "AmericanExpressXYZ",
          "AuthorisationType": "ConsumerDevice",
          "Name": "Asif KhanAli Hassan Mohammed",
          "Identification": "BH10XYZU00100000008876"
        },
      },
    ]
  },

"Links": {
    "Self": "www.TBC.com"
  },
  "Meta": {
    "TotalPages": 02TotalPages": 02,
    "FirstAvailableDateTime": "2020-03-24T09:10:17.596+03:00”,
    "FirstAvailableDateTimeLastAvailableDateTime": "2020-03-24T09:10:17.596+03:00”,
    "LastAvailableDateTime": "2020-03-24T09:10:17.596+03:00”
  }}:10:17.596+03:00”
  }

}

GET /accounts/00345897/transactions
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714
Accept: application/json

403 Forbidden

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f