Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

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

  • 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

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

OBReadSharingProductDetails/Data/Loans/Eligibility/CreditScore

Credit score of the loan applicant

String

 

 

Collateral

0..1

OBReadSharingProductDetails/Data/Loans/Eligibility/Collateral

List of collateral accepted against loan if applicable

String

 

 

Benefits

0..1

OBReadSharingProductDetails/Data/Loans/Benefits

List of Benefits offered by this product

OBReadSharingProductDetails/Data/Loans/Benefits

 

 

BonusPack

0..1

OBReadSharingProductDetails/Data/Loans/Benefits/BonusPack

"Free Priority/ Premium/ Easy Banking plan with credit card, 360° reward and welcome offers"

String

 

 

FreeMortgageValueAssessment

0..1

OBReadSharingProductDetails/Data/Loans/Benefits/FreeMortgageValueAssessment

"Free assessment of the value of the mortgage"

String

 

 

AutoPaySetup

0..1

OBReadSharingProductDetails/Data/Loans/Benefits/AutoPaySetup

"One stop pay"

String

 

 

E-cheque

0..1

OBReadSharingProductDetails/Data/Loans/Benefits/E-cheque

"Option of e cheque clearance"

String

 

 

EarlyEMIPaymentOptions

0..1

OBReadSharingProductDetails/Data/Loans/Benefits/EarlyEMIPaymentOptions

Benefit of early payment options

String

 

 

OtherBenefits

0..1

OBReadSharingProductDetails/Data/Loans/Benefits/OtherBenefits

Additional benefits if any

String

 

 

TermsAndConditions

0..1

OBReadSharingProductDetails/Data/Loans/TermsAndConditions

This includes a summary of the terms and conditions such as hidden charges, compliance requirements and other bank specific requirements

OBReadSharingProductDetails/Data/Loans/TermsAndConditions

 

 

tnc-title

0..1

OBReadSharingProductDetails/Data/Loans/TermsAndConditions/tnc-title

Terms and conditions title

String

 

 

tnc-summary

0..1

OBReadSharingProductDetails/Data/Loans/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/Loans/TermsAndConditions/tnc-url

Terms and conditions URL

String

 

 

SupplementaryData

0..1

OBReadSharingProductDetails/Data/Loans/SupplementaryData

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

OBSupplementaryData

 

 

CASA

0..n

OBReadSharingProductDetails/Data/CASA

List of CASA products

OBReadSharingProductDetails/Data/CASA

 

 

ProductDetails

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails

This Section covers basic product description

OBReadSharingProductDetails/Data/CASA/ProductDetails

 

 

CategoryName

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/CategoryName

Product category name used by the ASPSPs

String

 

 

CategoryCode

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/CategoryCode

Product category code used by the ASPSPs

String

 

 

ProductDescription

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/ProductDescription

A brief description of the product

String

 

 

ProductCode

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/ProductCode

Product Code for ASPSPs operational purpose

String

 

 

SubProductCode

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/SubProductCode

Sub-Product Code for ASPSPs operational purpose

String

 

 

ProductURL

0..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/ProductURL

Product URL

String

 

 

Segment

1..1

OBReadSharingProductDetails/Data/CASA/ProductDetails/Segment

Product segment such as lifestyle, travel, reward points, etc.

String

 

 

Features

0..1

OBReadSharingProductDetails/Data/CASA/Features

List of product features

OBReadSharingProductDetails/Data/CASA/Features

 

 

Currency

0..1

OBReadSharingProductDetails/Data/CASA/Features/Currency

Payment and transaction currency as applicable on the selected CASA type

String

 

 

MinBalanceMaintenance

0..1

OBReadSharingProductDetails/Data/CASA/Features/MinBalanceMaintenance

Minimum balance to be maintained by the account holder in BHD

String

 

 

HandlingFees/Supplementary

0..1

OBReadSharingProductDetails/Data/CASA/Features/HandlingFees/Supplementary

Account handling fees applicable for products in BHD excluding taxes per annum

String

 

 

OverdraftLimit

0..1

OBReadSharingProductDetails/Data/CASA/Features/OverdraftLimit

Limit offered by banks for the customer based on turnover and spending levels in BHD per month

String

 

 

InterestRates

0..1

OBReadSharingProductDetails/Data/CASA/Features/InterestRates

Interest payable on repayment of the loan amount- In Islamic banking, this field is referred to as ‘Profit/Charge’

String

 

 

DepositRate

0..1

OBReadSharingProductDetails/Data/CASA/Features/DepositRate

Interest rate applicable for deposits only- In Islamic banking, this field is referred to as ‘Profit/Charge’

String

 

 

MinDepositAmount

0..1

OBReadSharingProductDetails/Data/CASA/Features/MinDepositAmount

Minimum one time deposit amount in BHD

String

 

 

Eligibility

0..1

OBReadSharingProductDetails/Data/CASA/Eligibility

This covers nationality, age, employment status, income and credit score

OBReadSharingProductDetails/Data/CASA/Eligibility

 

 

DocumentsRequired

0..1

OBReadSharingProductDetails/Data/CASA/Eligibility/DocumentsRequired

List of documents required for opening a current account

String

 

 

Age

0..1

OBReadSharingProductDetails/Data/CASA/Eligibility/Age

Age of the applicant

Number

 

 

EmploymentStatus

0..1

OBReadSharingProductDetails/Data/CASA/Eligibility/EmploymentStatus

Employment status of the applicant

String

 

 

Income

0..1

OBReadSharingProductDetails/Data/CASA/Eligibility/Income

Income of the applicant

String

 

 

CreditScore

0..1

OBReadSharingProductDetails/Data/CASA/Eligibility/CreditScore

Credit score of the applicant

String

 

 

Benefits

0..1

OBReadSharingProductDetails/Data/CASA/Benefits

List of Benefits offered by this product

OBReadSharingProductDetails/Data/CASA/Benefits

 

 

RelationshipManager

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/RelationshipManager

This covers the benefits of availing RM under few conditions

String

 

 

ODprotection

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/ODprotection

Enjoy Current Account Overdraft Protection for clearing cheques

String

 

 

MinBalance

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/MinBalance

This describes the minimum balance required to keep the account active

String

 

 

AutoPaySetup

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/AutoPaySetup

One-stop pay

String

 

 

MultipleDebitCards

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/MultipleDebitCards

This includes details of add on debit cards where a account holder can apply for add-on cards for his/her employees under the same account

String

 

 

E-cheque

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/E-cheque

Option of E-cheque clearance

String

 

 

OtherBenefits

0..1

OBReadSharingProductDetails/Data/CASA/Benefits/OtherBenefits

Additional benefits if any

String

 

 

TermsAndConditions

0..1

OBReadSharingProductDetails/Data/CASA/TermsAndConditions

This includes a summary of the terms and conditions such as hidden charges, compliance requirements and other ASPSP specific requirements

OBReadSharingProductDetails/Data/CASA/TermsAndConditions

 

 

tnc-title

0..1

OBReadSharingProductDetails/Data/CASA/TermsAndConditions/tnc-title

Terms and conditions title

String

 

 

tnc-summary

0..1

OBReadSharingProductDetails/Data/CASA/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/CASA/TermsAndConditions/tnc-url

Terms and conditions URL

String

 

 

SupplementaryData

0..1

OBReadSharingProductDetails/Data/CASA/SupplementaryData

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

OBSupplementaryData

 

 

Investment

0..n

OBReadSharingProductDetails/Data/Investment

List of Investment products- In Islamic banking, this field is referred to as ‘Investment Account’

OBReadSharingProductDetails/Data/Investment

 

 

ProductDetails

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails

This Section covers basic product description

OBReadSharingProductDetails/Data/Investment/ProductDetails

 

 

CategoryName

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/CategoryName

Product category name used by the ASPSPs

String

 

 

CategoryCode

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/CategoryCode

Product category code used by the ASPSPs

String

 

 

ProductDescription

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/ProductDescription

A brief description of the product

String

 

 

ProductCode

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/ProductCode

Product Code for ASPSPs operational purpose

String

 

 

SubProductCode

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/SubProductCode

Sub-Product Code for ASPSPs operational purpose

String

 

 

ProductURL

0..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/ProductURL

Product URL

String

 

 

Segment

1..1

OBReadSharingProductDetails/Data/Investment/ProductDetails/Segment

Product segment such as lifestyle, travel, reward points, etc.

String

 

 

Features

0..1

OBReadSharingProductDetails/Data/Investment/Features

List of product features

OBReadSharingProductDetails/Data/Investment/Features

 

 

Currency

0..1

OBReadSharingProductDetails/Data/Investment/Features/Currency

Payment and transaction currency as applicable on the selected Investment type

String

 

 

MinInvestmentRequirement

0..1

OBReadSharingProductDetails/Data/Investment/Features/MinInvestmentRequirement

Minimum investment required for opening the investment account in BHD

String

 

 

HandlingFees/Supplementary

0..1

OBReadSharingProductDetails/Data/Investment/Features/HandlingFees/Supplementary

Account handling fees applicable for products in BHD excluding taxes per annum

String

 

 

AnnualFees

0..1

OBReadSharingProductDetails/Data/Investment/Features/AnnualFees

Recurring fees and charges payable periodically in BHD excluding of taxes

String

 

 

InvestmentTenure

0..1

OBReadSharingProductDetails/Data/Investment/Features/InvestmentTenure

Duration of investment period in months

String

 

 

DepositRate

0..1

OBReadSharingProductDetails/Data/Investment/Features/DepositRate

Interest rate applicable for deposits only- In Islamic banking, this field is referred to as ‘Profit/Charge’

String

 

 

HistoricInvestmentRate

0..1

OBReadSharingProductDetails/Data/Investment/Features/HistoricInvestmentRate

This covers the historic rates that are gained by the investors in the selected fund- In Islamic banking, this field is referred to as ‘Profit/Charge’

String

 

 

Eligibility

0..1

OBReadSharingProductDetails/Data/Investment/Eligibility

This covers nationality, age, employment status, income and credit score

OBReadSharingProductDetails/Data/Investment/Eligibility

 

 

DocumentsRequired

0..1

OBReadSharingProductDetails/Data/Investment/Eligibility/DocumentsRequired

List of documents required

String

 

 

Age

0..1

OBReadSharingProductDetails/Data/Investment/Eligibility/Age

Age of the applicant

Number

 

 

EmploymentStatus

0..1

OBReadSharingProductDetails/Data/Investment/Eligibility/EmploymentStatus

Employment status of the applicant

String

 

 

Income

0..1

OBReadSharingProductDetails/Data/Investment/Eligibility/Income

Income of the applicant

String

 

 

CreditScore

0..1

OBReadSharingProductDetails/Data/Investment/Eligibility/CreditScore

Credit score of the applicant

String

 

 

Benefits

0..1

OBReadSharingProductDetails/Data/Investment/Benefits

List of Benefits offered by this product

OBReadSharingProductDetails/Data/Investment/Benefits

 

 

SIPOptions

0..1

OBReadSharingProductDetails/Data/Investment/Benefits/SIPOptions

This covers the broader systematic investment plan option that a customer can opt for

String

 

 

QuickerInvestmentWithdrawal

0..1

OBReadSharingProductDetails/Data/Investment/Benefits/QuickerInvestmentWithdrawal

Customers can withdraw the investments within 24 hours of the request submitted

String

 

 

MinimumInvestment

0..1

OBReadSharingProductDetails/Data/Investment/Benefits/MinimumInvestment

This describes the minimum annual investment required to keep the account active

String

 

 

AutoPaySetup

0..1

OBReadSharingProductDetails/Data/Investment/Benefits/AutoPaySetup

One-stop pay

String

 

 

OtherBenefits

0..1

OBReadSharingProductDetails/Data/Investment/Benefits/OtherBenefits

Additional benefits if any

String

 

 

TermsAndConditions

0..1

OBReadSharingProductDetails/Data/Investment/TermsAndConditions

This includes a summary of the terms and conditions such as hidden charges, compliance requirements and other ASPSP specific requirements

OBReadSharingProductDetails/Data/Investment/TermsAndConditions

 

 

tnc-title

0..1

OBReadSharingProductDetails/Data/Investment/TermsAndConditions/tnc-title

Terms and conditions title

String

 

 

tnc-summary

0..1

OBReadSharingProductDetails/Data/Investment/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/Investment/TermsAndConditions/tnc-url

Terms and conditions URL

String

 

 

SupplementaryData

0..1

OBReadSharingProductDetails/Data/Investment/SupplementaryData

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

OBSupplementaryData

 

 

FundTransferServices

0..n

OBReadSharingProductDetails/Data/FundTransferServices

List of Fund Transfer Services products

OBReadSharingProductDetails/Data/FundTransferServices

 

 

ProductDetails

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails

This Section covers basic product description

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails

 

 

CategoryName

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/CategoryName

Product category name used by the ASPSPs

String

 

 

CategoryCode

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/CategoryCode

Product category code used by the ASPSPs

String

 

 

ProductDescription

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/ProductDescription

A brief description of the product

String

 

 

ProductCode

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/ProductCode

Product Code for ASPSPs operational purpose

String

 

 

SubProductCode

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/SubProductCode

Sub-Product Code for ASPSPs operational purpose

String

 

 

ProductURL

0..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/ProductURL

Product URL

String

 

 

Segment

1..1

OBReadSharingProductDetails/Data/FundTransferServices/ProductDetails/Segment

Product segment such as lifestyle, travel, reward points, etc.

String

 

 

Features

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Features

List of product features

OBReadSharingProductDetails/Data/FundTransferServices/Features

 

 

Currency

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Features/Currency

Payment and transaction currency as applicable on the selected service type

String

 

 

MinFundTransfer

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Features/MinFundTransfer

Minimum fund transfer applicable for the type of service selected in BHD

String

 

 

HandlingFees/Supplementary

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Features/HandlingFees/Supplementary

Account handling fees applicable for products in BHD excluding taxes per annum

String

 

 

TypesOfFundTransfer

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Features/TypesOfFundTransfer

This covers different type of fund transfer that banks offer to the customers

String

 

 

Eligibility

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility

This covers nationality, age, employment status, income and credit score

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility

 

 

DocumentsRequired

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility/DocumentsRequired

List of documents required

String

 

 

Age

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility/Age

Age of the applicant

Number

 

 

EmploymentStatus

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility/EmploymentStatus

Employment status of the applicant

String

 

 

Income

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility/Income

Income of the applicant

String

 

 

CreditScore

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Eligibility/CreditScore

Credit score of the applicant

String

 

 

Benefits

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Benefits

List of Benefits offered by this product

OBReadSharingProductDetails/Data/FundTransferServices/Benefits

 

 

InternationalPayment

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Benefits/InternationalPayment

International payment with other currency pay-outs

String

 

 

OtherBenefits

0..1

OBReadSharingProductDetails/Data/FundTransferServices/Benefits/OtherBenefits

Additional benefits if any

String

 

 

TermsAndConditions

0..1

OBReadSharingProductDetails/Data/FundTransferServices/TermsAndConditions

This includes a summary of the terms and conditions such as hidden charges, compliance requirements and other bank specific requirements

OBReadSharingProductDetails/Data/FundTransferServices/TermsAndConditions

 

 

tnc-title

0..1

OBReadSharingProductDetails/Data/FundTransferServices/TermsAndConditions/tnc-title

Terms and conditions title

String

 

 

tnc-summary

0..1

OBReadSharingProductDetails/Data/FundTransferServices/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/FundTransferServices/TermsAndConditions/tnc-url

Terms and conditions URL

String

 

 

SupplementaryData

0..1

OBReadSharingProductDetails/Data/FundTransferServices/SupplementaryData

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

OBSupplementaryData

 

 

5. Usage Examples

5.1 GET /sharing-product-details

5.1.1 Request

GET /sharing-product-details

Authorization: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-fapi-auth-date: Tue, 22 Apr 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

5.1.2 Response

200 OK

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

Content-Type: application/json

{

  "Data": {

    "CreditCards": [

      {

        "ProductDetails": {

          "CategoryName": "Credit-card",

          "CategoryCode": "CC",

          "ProductDescription": "XYZ platinum premium credit cards",

          "ProductCode": "XYZ-1",

          "SubProductCode": "XYZ-101",

          "ProductURL": "http//xyz.com/creditcards/",

          "Segment": "lifestyle"

        },

        "Features": {

          "Currency": "BHD",

          "OnetimeFee": 100,

          "AnnualFeeAndCharges": 50,

          "FeeWaiver": "Under the following condition: customer to have made the transaction of >10,000 BHD in the financial year",

          "AddOnCards": "2 complimentary add on card for the family members with limited transaction options",

          "CardLimit": "1000 BHD per month",

          "InterestRates": "2.5% exclusive of taxes per month"

        },

        "Eligibility": {

          "DocumentsRequired": "1. Address proof 2. salary slip 3. bank statement, etc.",

          "Age": 26,

          "EmploymentStatus": "Employed",

          "Income": ">10,000 BHD per annum",

          "CreditScore": "700"

        },

        "Benefits": {

          "OffersOnTheCard": "Get up to 20% off at the selected restaurants in Bahrain"

          "RewardType": " PremierMiles Credit Card",

          "RewardsProgram": " Free access to selected airport lounges",

          "JoiningGiftsOrBonus": "Complementary 100 reward points on joining",

          "OtherBenefits": " Immediate access to XYZ ATMs worldwide"

        },

      "TermsAndConditions": {,

          "tnc-url": "http//xyz.com/creditcards/tnc/"

        }

      }

    ],

    "Loans": [

      {

        "ProductDetails": {

          "CategoryName": "Personal loan",

          "CategoryCode": "LN",

          "ProductDescription": "XYZ educational loan",

          "ProductCode": "XYZ-L",

          "SubProductCode": "XYZ-L-101",

          "ProductURL": "http//xyz.com/loans/",

          "Segment": "personal"

        },

        "Features": {

          "Currency": "BHD",

          "InitialDeposit": "100",

          "HandlingFees/Supplementary": "50",

          "LoanTenure": "48",

          "InterestRates": "8% inclusive of taxes"

        },

        "Eligibility": {

          "DocumentsRequired": "1. Address proof 2. salary slip 3. bank statement, etc.",

          "Age": 26,

          "EmploymentStatus": "Employed",

          "Income": ">10,000 BHD per annum",

          "CreditScore": "700",

          "Collateral": "1. mortgages such as house"

        },

        "Benefits": {

          "BonusPack": "Free card issuance fee for the first year, Bank representative can provide the service at your doorsteps",

          "FreeMortgageValueAssessment": " ",

          "AutoPaySetup": " Auto pay option available for repayment",

          "E-cheque": " Access e-Cheque services anywhere in the world through the Internet",

          "EarlyEMIPaymentOptions": " Three month grace period option",

          "OtherBenefits": "Free Home Protect cover from XYZ for the Ijara option"

        },

        "TermsAndConditions": {,

          "tnc-url": "http//xyz.com/loans/tnc/"

        }

      }

    ],

"CASA": [

      {

        "ProductDetails": {

          "CategoryName": "Current account Saving account",

          "CategoryCode": "CASA",

          "ProductDescription": "XYZ Current account",

          "ProductCode": "XYZ-CASA",

          "SubProductCode": "XYZ-CASA-101",

          "ProductURL": "http//xyz.com/casa/",

          "Segment": "Retail"

        },

        "Features": {

          "Currency": "BHD",

          "MinBalanceMaintenance": "25",

          "HandlingFees/Supplementary": "50",

          "OverdraftLimit": "10000",

          "InterestRates": "8% inclusive of taxes",

          "DepositRate": "4% inclusive of taxes",

          "MinDepositAmount": "10"

        },

        "Eligibility": {

          "DocumentsRequired": "1. Address proof 2. Business documents 3. bank statement, etc.",

          "Age": 26,

          "EmploymentStatus": "Employed",

          "Income": ">10,000 BHD per annum",

          "CreditScore": "700"

        },

        "Benefits": {

          "RelationshipManager": "A dedicated relationship manager, as well as an exclusive debit card with additional privileges",

          "ODprotection": "We offer protection to make sure you are temporarily covered when withdrawing funds in excess of your account   balance",

          "MinBalance": "Minimum Initial deposit of BD 20 or USD 50": "A minimum balance charge of BD 1 if the average monthly balance is less than BD 20 or equivalent. This may be updated as per the Bank’s Schedule of Fees and Service Charges",

          "AutoPaySetup": "Standing instruction facility",

          "MultipleDebitCards": " Free Debit card at the time of account opening for individuals, Joint Personal, Sole Proprietorship",

          "E-cheque": "Free access to eBanking channels and Phone Banking",

          "OtherBenefits": "Can be opened in Bahraini Dinars and US Dollars, Easy money transfer options between your own accounts or to other beneficiaries within Bahrain or overseas"

        },

        "TermsAndConditions": {,

          "tnc-url": "http//xyz.com/casa/tnc/"

        }

      }

    ],

 "Investment": [

      {

        "ProductDetails": {

          "CategoryName": "Investment account",

          "CategoryCode": "IA",

          "ProductDescription": "XYZ Investment service",

          "ProductCode": "XYZ-IA",

          "SubProductCode": "XYZ-IA-101",

          "ProductURL": "http//xyz.com/investment/",

          "Segment": "Retail"

        },

        "Features": {

          "Currency": "BHD",

          "MinInvestmentRequirement": "1000",

          "HandlingFees/Supplementary": "50",

          "AnnualFees": "50",

          "InvestmentTenure": "48",

          "DepositRate": "4% inclusive of taxes",

          "HistoricInvestmentRate": "year wise % return

                                                2008-15%

                                                2009-20%

                                                ……

                                                2019-17%"

        },

        "Eligibility": {

          "DocumentsRequired": "1. Address proof 2. Business documents 3. bank statement, etc.",

          "Age": 26,

          "EmploymentStatus": "Employed",

          "Income": ">10,000 BHD per annum",

          "CreditScore": "700"

        },

        "Benefits": {

          "SIPOptions": "Minimum SIP amount of 50 BHD per month",

          "QuickerInvestmentWithdrawal": "All transmission costs, service charges and any other charges and expenses whatsoever of any kind relating to withdrawals from an Account will be paid by the Customer in full without deduction or set-off immediately upon demand or by debiting the relevant Account(s)",

          "MinimumInvestment": "Minimum deposit of BHD 1,000 for BHD currency deposits",

          "AutoPaySetup": "Standing instruction facility",

          "OtherBenefits": "Flexible profit distribution on a monthly basis, or at maturity"

        },

        "TermsAndConditions": {,

          "tnc-url": "http//xyz.com/investment/tnc/"

        }

      }

    ],

 "FundTransferServices": [

      {

        "ProductDetails": {

          "CategoryName": "Fund transfer",

          "CategoryCode": "FT",

          "ProductDescription": "XYZ Fund transfer service",

          "ProductCode": "XYZ-FT",

          "SubProductCode": "XYZ-FT-101",

          "ProductURL": "http//xyz.com/fundtransferservices/",

          "Segment": "Retail"

        },

        "Features": {

          "Currency": "BHD",

          "MinFundTransfer": "10",

          "HandlingFees/Supplementary": "50",

          "TypesOfFundTransfer": "1. Fawri

2. Fawri+

3. Fawateer"

        },

        "Eligibility": {

          "DocumentsRequired": "1. Address proof 2. Business documents 3. bank statement, etc.",

          "Age": 26,

          "EmploymentStatus": "Employed",

          "Income": ">10,000 BHD per annum",

          "CreditScore": "700"

        },

        "Benefits": {

          "InternationalPayment": "Facility of international payments is conveniently available through mobile and internet banking, as well as through any branch",

          "OtherBenefits": "The Bank offers speedy money transfer services to most countries in the world in major currencies"

        },

        "TermsAndConditions": {,

          "tnc-url": "http//xyz.com/fundtransferservices/tnc/"

        }

      }

    ]

  }

}

CENTRAL BANK OF BAHRAIN © 2020

  • No labels