Sharing Product Details API
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The Sharing product details API is used by an AISP to request an ASPSP to retrieve list of products details and features.
3. Endpoints
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Request Object | Response Object |
3.1 | sharing product details | GET | GET /sharing-product-details | Mandatory | Client Credentials | No | NA | OBReadSharingProductDetails |
4. Data Models
The data dictionary section gives detail on the payload content for the Sharing Product Details API flows.
4.1 Sharing Product Details – Response
The OBReadSharingProductDetails object will be used for the call to:
GET /sharing-product-details
4.1.1 UML Diagram
4.1.2 Notes
The sharing-product-details response contains the full payload of all the products sent by ASPSP.
Below are the products:
Credit Cards
Loans- In Islamic banking, this field is referred to as ‘Financings’
CASA- Current Account and Savings Account
Investment- In Islamic banking, this field is referred to as ‘Investment Account’
Fund Transfer Services
Each of the products contains below elements:
Product Details
Features
Eligibility
Benefits
Terms and Conditions
In addition, the following information can be requested through the Sharing Product Details API
Branch
ATM
4.1.3 Data Dictionary
The fields mentioned in the UML diagram are basic product details and features for banks to incorporate in the APIs. Based on the specific cases and applicability, banks may choose to increase the fields for sharing with the AISPs. Also, banks that are not offering any products/services might choose not to build them in the APIs.
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBReadSharingProductDetails |
| OBReadSharingProductDetails |
| OBReadSharingProductDetails |
|
|
Data | 1..1 | OBReadSharingProductDetails/Data |
| OBReadSharingProductDetails/Data |
|
|
CreditCards | 0..n | OBReadSharingProductDetails/Data/CreditCards | List of Credit card products | OBReadSharingProductDetails/Data/CreditCards |
|
|
ProductDetails | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails | This Section covers basic product description | OBReadSharingProductDetails/Data/CreditCards/ProductDetails |
|
|
CategoryName | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/CategoryName | Product category name used by ASPSPs | String |
|
|
CategoryCode | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/CategoryCode | Product category code used by ASPSPs | String |
|
|
ProductDescription | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/ProductDescription | A brief description of the product | String |
|
|
ProductCode | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/ProductCode | Product Code for ASPSPs operational purpose | String |
|
|
SubProductCode | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/SubProductCode | Sub-Product Code for ASPSPs operational purpose | String |
|
|
ProductURL | 0..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/ProductURL | Product URL | String |
|
|
Segment | 1..1 | OBReadSharingProductDetails/Data/CreditCards/ProductDetails/Segment | Product segment such as lifestyle, travel, reward points, etc. | String |
|
|
Features | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features | List of product features | OBReadSharingProductDetails/Data/CreditCards/Features |
|
|
Currency | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/Currency | Payment and transaction currency as applicable on the selected card | String |
|
|
OnetimeFee | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/OnetimeFee | First time membership or fee payable on getting a card in BHD excluding taxes | Number |
|
|
AnnualFeeAndCharges | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/AnnualFeeAndCharges | Recurring fees and charges payable periodically in BHD excluding taxes | Number |
|
|
FeeWaiver | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/FeeWaiver | This includes the conditions for fee waiver if any applicable on the selected card | String |
|
|
AddOnCards | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/AddOnCards | This includes the conditions and limit for add on cards where a card holder can apply for add-on cards for his/her family under the same account | String |
|
|
CardLimit | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/CardLimit | Transaction limit offered by banks for the customer. This also includes the limits for sub transaction such as ATM withdrawal limit, merchant transaction limit, etc. | String |
|
|
InterestRates | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Features/InterestRates | Interest rate payable on repayment post due date- In Islamic banking, this field is referred to as ‘Profit/Charge’ | String |
|
|
Eligibility | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Eligibility | This covers nationality, age, employment status, income and credit score | OBReadSharingProductDetails/Data/CreditCards/Eligibility |
|
|
DocumentsRequired | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Eligibility/DocumentsRequired | List of documents required for getting a credit card | String |
|
|
Age | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Eligibility/Age | Age | Number |
|
|
EmploymentStatus | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Eligibility/EmploymentStatus | Employment status | String |
|
|
Income | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Eligibility/Income | Income | String |
|
|
CreditScore | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Eligibility/CreditScore | Credit score | String |
|
|
Benefits | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Benefits | List of Benefits offered by this product | OBReadSharingProductDetails/Data/CreditCards/Benefits |
|
|
OffersOnTheCard | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Benefits/OffersOnTheCard | Some cards have great offers and discounts if used with a particular vendor, website or company. Also banks have tie ups with offices, educational institutions etc. and offer them special rates | String |
|
|
RewardType | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Benefits/RewardType | Some cards are specifically made to suit customers spending habits. For e.g. travel, aviation, lifestyle, shopping, cashback etc. | String |
|
|
RewardsProgram | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Benefits/RewardsProgram | Rewards program offered by Banks including cashback and redeemable options. Fuel charge waivers and airport lounge access will also be covered here | String |
|
|
JoiningGiftsOrBonus | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Benefits/JoiningGiftsOrBonus | To get customers to apply for their card, banks offer welcome gifts and bonuses. This could be some latest gadget or bonus points and miles | String |
|
|
OtherBenefits | 0..1 | OBReadSharingProductDetails/Data/CreditCards/Benefits/OtherBenefits | Additional benefits if any | String |
|
|
TermsAndConditions | 0..1 | OBReadSharingProductDetails/Data/CreditCards/TermsAndConditions | This includes a summary of the terms and conditions such as hidden charges, compliance requirements and other bank-specific requirements | OBReadSharingProductDetails/Data/CreditCards/TermsAndConditions |
|
|
tnc-title | 0..1 | OBReadSharingProductDetails/Data/CreditCards/TermsAndConditions/tnc-title | Terms and conditions title | String |
|
|
tnc-summary | 0..1 | OBReadSharingProductDetails/Data/CreditCards/TermsAndConditions/tnc-summary | Any material conditions and specific features such as salary transfer, minimum equity for mortgage facility, loan to value ratio etc. | String |
|
|
tnc-url | 0..1 | OBReadSharingProductDetails/Data/CreditCards/TermsAndConditions/tnc-url | Terms and conditions URL | String |
|
|
SupplementaryData | 0..1 | OBReadSharingProductDetails/Data/CreditCards/SupplementaryData | Additional information that can not be captured in the structured fields and/or any other specific block | OBSupplementaryData |
|
|
Loans | 0..n | OBReadSharingProductDetails/Data/Loans | List of Loans products- In Islamic banking, this field is referred to as ‘Financings’ | OBReadSharingProductDetails/Data/Loans |
|
|
ProductDetails | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails | This Section covers basic product description | OBReadSharingProductDetails/Data/Loans/ProductDetails |
|
|
CategoryName | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/CategoryName | Product category name used by ASPSPs | String |
|
|
CategoryCode | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/CategoryCode | Product category code used by the ASPSPs | String |
|
|
ProductDescription | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/ProductDescription | A brief description of the product | String |
|
|
ProductCode | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/ProductCode | Product Code for Banks operational purpose | String |
|
|
SubProductCode | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/SubProductCode | Sub-Product Code for Banks operational purpose | String |
|
|
ProductURL | 0..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/ProductURL | Product URL | String |
|
|
Segment | 1..1 | OBReadSharingProductDetails/Data/Loans/ProductDetails/Segment | Product segment such as lifestyle, travel, reward points, etc. | String |
|
|
Features | 0..1 | OBReadSharingProductDetails/Data/Loans/Features | List of product features | OBReadSharingProductDetails/Data/Loans/Features |
|
|
Currency | 0..1 | OBReadSharingProductDetails/Data/Loans/Features/Currency | Payment and transaction currency as applicable on the selected loan type | String |
|
|
InitialDeposit | 0..1 | OBReadSharingProductDetails/Data/Loans/Features/InitialDeposit | Initial amount payable by the customer in BHD excluding taxes | String |
|
|
HandlingFees/Supplementary | 0..1 | OBReadSharingProductDetails/Data/Loans/Features/HandlingFees/Supplementary | Loan handling fees applicable for products in BHD excluding taxes | String |
|
|
MinTenure | 0..1 | OBReadSharingProductDetails/Data/Loans/Features/MinTenure | Minimum duration of loan period in months | String |
|
|
MaxTenure | 0..1 | OBReadSharingProductDetails/Data/Loans/Features/MaxTenure | Maximum duration of loan period in months | String |
|
|
InterestRates | 0..1 | OBReadSharingProductDetails/Data/Loans/Features/InterestRates | Interest payable on repayment of the loan amount- In Islamic banking, this field is referred to as ‘Profit/Charge’ | String |
|
|
Eligibility | 0..1 | OBReadSharingProductDetails/Data/Loans/Eligibility | This covers nationality, age, employment status, income and credit score | OBReadSharingProductDetails/Data/Loans/Eligibility |
|
|
DocumentsRequired | 0..1 | OBReadSharingProductDetails/Data/Loans/Eligibility/DocumentsRequired | List of documents required for getting a loan | String |
|
|
Age | 0..1 | OBReadSharingProductDetails/Data/Loans/Eligibility/Age | Age of the loan applicant | Number |
|
|
EmploymentStatus | 0..1 | OBReadSharingProductDetails/Data/Loans/Eligibility/EmploymentStatus | Employment status of the loan applicant | String |
|
|
Income | 0..1 | OBReadSharingProductDetails/Data/Loans/Eligibility/Income | Income of the loan applicant | String |
|
|
CreditScore | 0..1 |