| Table of Contents | ||
|---|---|---|
|
...
|
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The supplementary account info resource is used by an AISP to retrieve the account product information for a specific AccountId.
The products resource is used by an AISP to retrieve the products for all authorised accounts linked to a specific account-request.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
...
3.
...
Endpoints
Endpoints for the resource - and available methods.
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | ?Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object | ||||||||||
3.1products | supplementary-account-info | GET/ | GET /accounts/{AccountId}/product | Conditional | accounts | Authorization Code | No |
|
| OBReadProduct | 2 | products | GET/GET /productssupplementary-account-info | Optional | accounts | Authorization Authorisation Code | No | PaginationOBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
...
OBReadProduct
...
3.1
...
GET /accounts/{AccountId}/
...
supplementary-account-info
An AISP may retrieve the account product information for a specific AccountId (which is retrieved in the call to GET /accounts). While this This endpoint is marked as Conditional, it will be Mandatory Optional for ASPSPs and account types covered in the CMA Order.
2.2. GET /products
If an ASPSP has implemented the bulk retrieval endpoints for products an AISP may optionally retrieve the products information in bulk. This endpoint will retrieve the products resources for all authorised accounts linked to a specific account-request
...
.
4. Data Model
The OBReadProduct2 OBReadSupplementaryAccountInfo OBReadSupplementaryAccountInfo object will be used for the call to:
...
GET /accounts/{AccountId}/product
GET /products
8.2.2
8.2.3
2.1. UML DIAGRAM
supplementary-account-info
4.1 UML Diagram
...
4.2 Permission Codes
The resource requires the ReadProducts ReadSupplementaryAccountInfo permission. The resource response payload does not differ depending on the permissions granted.
...
4.3
...
Data Dictionary
Name | Occurrence | XPath | EnhancedDefinitionEnhanced Definition | Class/ Datatype | Codes | Pattern | |||||||||
OBReadProductOBReadSupplementaryAccountInfo |
| OBReadProductOBReadSupplementaryAccountInfo |
| OBReadProductOBReadSupplementaryAccountInfo |
|
| |||||||||
Data | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data |
| OBReadProductOBReadSupplementaryAccountInfo/Data |
|
| |||||||||
CASAReadAccount | 0..n1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount |
| OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount |
|
| |||||||||
AccountNumber AccountID | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/AccountNumber | Bank Account number | String |
|
| AccountType | 1..1 | OBReadProduct/Data/CASA/AccountType | Type of account as classified by the ASPSP (eg. Savings Account, Current account)AccountID | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner | String |
|
| |
ProductTypeDescription DateTime | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/ProductTypeDescription | Full description of the product | String |
|
| AccountName | 1..1 | OBReadProduct/Data/CASA/AccountName | Full account name | StringDateTime | Date on which the account and related basic services are effectively operational for the account owner | DateTime |
|
|
BranchName ReadCASAInfo | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/BranchName ReadCASAInfo | Branch Name | String |
|
| AccountStatus | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASA/AccountStatus | One of ‘active’/’inactive’/'dormant'/’frozen’ (A/I/D/F) | StringReadAccount/ReadCASAInfo |
|
| ||
AccountClosed LienAmount | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASA/AccountClosed | Y or N | String |
|
| |||||||||
AccountCurrency | 1..1 | OBReadProduct/Data/CASA/AccountCurrency | Currency code | String |
|
| |||||||||
AvailableBalance | 1..1 | OBReadProduct/Data/CASA/AvailableBalance | Withdrawable balance + funds in clearing | String |
|
| |||||||||
EffectiveAvailableBalance | 1..1 | OBReadProduct/Data/CASA/EffectiveAvailableBalance | Withdrawable balance | String |
|
| |||||||||
LienAmount | 1..1 | OBReadProduct/Data/CASA/LienAmount | ReadAccount/ReadCASAInfo /LienAmount | Lien amount marked | String |
|
| ||||||||
IBAN Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/ReadCASAInfo /IBAN | IBAN account number | String |
|
| ExchangeRate | 1..1 | OBReadProduct/Data/CASA/ExchangeRate | Conversion rate in case of foreign currency (to BHD). In case the currency of the account is BHD, value will be 1.000Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount)- In Islamic banking, this field is referred to as ‘Profit/ Charge’ | String |
|
| |
AccountOpeningDate JointHolderName | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASA/AccountOpeningDate | Account opening date | DateTime |
|
| |||||||||
AccountClosingDate | 1..1 | OBReadProduct/Data/CASA/AccountClosingDate | If the account is closed then Account closed date should be available. | DateTime |
|
| |||||||||
JointHoldersCPRs | 0..1 | OBReadProduct/Data/CASA/JointHoldersCPRsReadAccount/ReadCASAInfo /JointHolderName | List of joint account holder CPRsname | String |
|
| |||||||||
InvestmentReadDepositInfo | 0..n1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Investment |
| OBReadProduct/Data/InvestmentReadAccount/ReadDepositInfo |
|
| AccountNumber | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Investment/AccountNumber | Bank Account number | String | ReadAccount/ReadDepositInfo |
|
| |
AccountType Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/InvestmentReadDepositInfo /AccountType | Type of account as classified by the ASPSP (eg. Savings Account, Current account) | String |
|
| ProductTypeDescription | 1..1 | OBReadProduct/Data/Investment/ProductTypeDescription | Full description of the product | Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount)- In Islamic banking, this field is referred to as ‘Profit/ Charge’ | String |
|
|
AccountName InitialDepositAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Investment/AccountName | Full account name | String |
|
| BranchName | 1..1 | OBReadProduct/Data/Investment/BranchName | Branch NameReadAccount/ReadDepositInfo /InitialDepositAmount | Initial deposit amount | String |
|
| |
AccountStatus DepositFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Investment/AccountStatus | One of ‘active’/’inactive’/'dormant'/’frozen’ (A/I/D/F) | String |
|
| |||||||||
AccountClosed | 1..1 | OBReadProduct/Data/Investment/AccountClosed | Y or N | String |
|
| |||||||||
AccountCurrency | 1..1 | OBReadProduct/Data/Investment/AccountCurrency | Currency code | String |
|
| |||||||||
Rate | 1..1 | OBReadProduct/Data/Investment/Rate | Interest rate / profit rate for islamic banks | String |
|
| |||||||||
InitialDepositAmount | 1..1 | OBReadProduct/Data/Investment/InitialDepositAmount | Initial deposit amount | String |
|
| |||||||||
DepositTerms- Months | 1..1 | OBReadProduct/Data/Investment/DepositTerms- Months | Deposit terms in months (in case of years convert to months) | String |
|
| |||||||||
DepositTerms - Days | 1..1 | OBReadProduct/Data/Investment/DepositTerms - Days | Deposit term in days | String |
| ReadAccount/ReadDepositInfo /DepositFrequency | Regularity with which deposit are made/processed to the account | String | Enum:
|
| |||||
MaturityAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/InvestmentReadAccount/ReadDepositInfo /MaturityAmount | Maturity Amount | String |
|
| |||||||||
MaturityDate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/InvestmentReadAccount/ReadDepositInfo /MaturityDate | Maturity Date | DateTime |
|
| |||||||||
IBAN JointHolderName | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Investment/IBAN | IBAN account number | String |
|
| |||||||||
ExchangeRate | 1..1 | OBReadProduct/Data/Investment/ExchangeRate | Conversion rate in case of foreign currency (to BHD). In case the currency of the account is BHD, value will be 1.000 | String |
|
| |||||||||
AccountOpeningDate | 1..1 | OBReadProduct/Data/Investment/AccountOpeningDate | Account opening date | DateTime |
|
| |||||||||
AccountClosingDate | 1..1 | OBReadProduct/Data/Investment/AccountClosingDate | If the account is closed then Account closed date should be available. | DateTime |
|
| |||||||||
JointHoldersCPRs | 0..1 | OBReadProduct/Data/Investment/JointHoldersCPRs | ReadAccount/ReadDepositInfo /JointHolderName | List of joint account holder CPRsname | String |
|
| ||||||||
LoansReadLoanMortgageInfo | 0..n | OBReadProduct/Data/Loans |
| OBReadProduct/Data/Loans |
|
| AccountNumber | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ AccountNumber | Bank Account number | String |
|
| ||
LoanType | 1..1 | OBReadProduct/Data/Loans/LoanType | Type of account as classified by the ASPSP (eg. Savings Account, Current account) | String |
|
| |||||||||
ProductTypeDescription | 1..1 | OBReadProduct/Data/Loans/ProductTypeDescription | Full description of the product | String |
|
| |||||||||
AccountName | 1..1 | OBReadProduct/Data/Loans/AccountName | Full account name | String |
|
| |||||||||
BranchName | 1..1 | OBReadProduct/Data/Loans/BranchName | Branch Name | String |
|
| |||||||||
AccountStatus | 1..1 | OBReadProduct/Data/Loans/AccountStatus | One of ‘active’/’inactive’/'dormant'/’frozen’ (A/I/D/F) | String |
|
| |||||||||
AccountClosed | 1..1 | OBReadProduct/Data/Loans/AccountClosed | Y or N | String |
|
| |||||||||
AccountCurrency ReadLoanMortgageInfo | In Islamic banking, this field is referred to as ‘Financing/ Property Finance' | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo |
|
| |||||||||||
Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Loans/AccountCurrency | Currency code | String |
|
| Rate | 1..1 | OBReadProduct/Data/Loans/Rate | Interest rate / profit rate for islamic banksReadAccount/ ReadLoanMortgageInfo /Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount)- In Islamic banking, this field is referred to as ‘Profit/ Charge’ | String |
|
| |
LoanAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ LoansReadLoanMortgageInfo /LoanAmount | Initial Loan Amount issued to the account- In Islamic banking, this field is referred to as ‘Finance Amount’ | String |
|
| |||||||||
DisbursedAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ LoansReadLoanMortgageInfo /DisbursedAmount | Disbursed Amount till date to the account | String |
|
| |||||||||
OutstandingLoanAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ ReadLoanMortgageInfo /OutstandingLoanAmount | Outstanding Loan Amount- In Islamic banking, this field is referred to as ‘Outstanding Finance Amount’ | String |
|
| |||||||||
Numberofinstallments | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ ReadLoanMortgageInfo /Numberofinstallments | Number of installments | String |
|
| |||||||||
LoanTerms - Months LoanFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Loans/LoanTerms - Months | Deposit terms in months (in case of years convert to months) | String |
|
| |||||||||
DepositTerms - Days | 1..1 | OBReadProduct/Data/Loans/DepositTerms - Days | Deposit term in days | String |
|
| |||||||||
IBAN | 1..1 | OBReadProduct/Data/Loans/IBAN | IBAN account number | String |
|
| |||||||||
ExchangeRate | 1..1 | OBReadProduct/Data/Loans/ExchangeRate | Conversion rate in case of foreign currency (to BHD). In case the currency of the account is BHD, value will be 1.000 | String |
|
| |||||||||
AccountOpeningDate | 1..1 | OBReadProduct/Data/Loans/AccountOpeningDate | Account opening date | DateTime |
|
| |||||||||
AccountClosingDate | 1..1 | OBReadProduct/Data/Loans/AccountClosingDate | If the account is closed then Account closed date should be available. | DateTime |
|
| |||||||||
JointHoldersCPRs | 0..1 | OBReadProduct/Data/Loans/JointHoldersCPRsReadAccount/ ReadLoanMortgageInfo /LoanFrequency | Regularity with which the installment is applied to the Account | String | Enum:
|
| |||||||||
JointHolderName | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /JointHolderName | List of joint account holder CPRsname | String |
|
| |||||||||
CreditCardsReadCreditCardInfo | 0..n1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ ReadCreditCardInfo |
| OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadCreditCardInfo |
|
| |||||||||
CardNumber Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ ReadCreditCardInfo /CardNumber Card NumberRate | Rate charged for the account (where it is charged in terms of a rate rather than an amount)- In Islamic banking, this field is referred to as ‘Profit/ Charge’ | String |
|
| |||||||||
CardIssuer CardLimit | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ ReadCreditCardInfo /CardIssuer Card IssuerCardLimit | Credit Limit applied to the account | String |
|
| |||||||||
CardType GracePeriod | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadCreditCardInfo/ CardType Card TypeGracePeriod | The duration after the due date during which the payment can be received without penalty | String |
|
| |||||||||
ProductTypeDescription URL | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadCreditCardInfo/ProductTypeDescription Product type descriptionURL | Uniform resource locator of the specified product | String |
|
| |||||||||
CardName ReadEWalletInfo | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCards/CardName | Card Name | StringReadAccount/ ReadEWalletInfo |
|
| BranchName | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCards/BranchName | Branch Name | StringReadAccount/ ReadEWalletInfo |
|
| ||
CardStatus Charge | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCards/CardStatus Card statusReadEWalletInfo/Charge | Fee charged for the account (where it is charged in terms of an amount)
| String |
|
| |||||||||
CardClosed ChargeFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ ReadEWalletInfo/CardClosed Card ClosedChargeFrequency | Regularity with which the fee is applied to the Account | String |
|
| |||||||||
CardCurrency | 1..1 | OBReadProduct/Data/CreditCards/CardCurrency | Card currency | String |
|
| |||||||||
CardBalance | 1..1 | OBReadProduct/Data/CreditCards/CardBalance | Card Balance | String |
|
| |||||||||
Rate | 1..1 | OBReadProduct/Data/CreditCards/Rate | Rate | String |
|
| |||||||||
CardLimit | 1..1 | OBReadProduct/Data/CreditCards/CardLimit | Card Limit | String |
|
| |||||||||
MinimumDue | 1..1 | OBReadProduct/Data/CreditCards/MinimumDue | Minimum Due | String |
|
| |||||||||
TotalDue | 1..1 | OBReadProduct/Data/CreditCards/TotalDue | Total Due | String |
|
| |||||||||
PaymentDueDate | 1..1 | OBReadProduct/Data/CreditCards/PaymentDueDate | Payment Due date | DateTime |
|
| |||||||||
AddOnCards | 1..1 | OBReadProduct/Data/CreditCards/AddOnCards | Add on cards | String |
|
| |||||||||
ExchangeRate | 1..1 | OBReadProduct/Data/CreditCards/ ExchangeRate | ExchangeRate | String |
|
| |||||||||
CardIssueDate | 1..1 | OBReadProduct/Data/CreditCards/CardIssueDate | Card Issue date | DateTime |
|
| |||||||||
CardClosingDate | 1..1 | OBReadProduct/Data/CreditCards/CardClosingDate | Card closing date | DateTime |
|
|
4. Usage Example
Specific Account
Enum:
|
|
5. Usage Example
5.1 Get Supplementary Account Info
5.1.1 Request
|
5.1.2 Response
|
|
CENTRAL BANK OF BAHRAIN © 2020