1. Overview

The product 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.

2. Endpoints

Endpoints for the resource - and available methods.

_Resource	_{HTTP Operation}	_Endpoint	_Mandatory?	_Scope	_{Grant Type}	_{Idempotency Key}	_Parameters	_{Request Object}	_{Response Object}
₁	_products	_{GET/GET /accounts/{AccountId}/product}	_Conditional	_accounts	_{Authorization Code}	_No			_{OBReadProduct}
₂	_products	_{GET/GET /products}	_Optional	_accounts	_{Authorization Code}	_No	_Pagination		_{OBReadProduct}

2.1 GET /accounts/{AccountId}/product

An AISP may retrieve the account product information for a specific AccountId (which is retrieved in the call to GET /accounts). While this endpoint is marked as Conditional, it will be Mandatory 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

3. Data Model

The OBReadProduct2 object will be used for the call to:

GET /accounts/{AccountId}/product
GET /products

2.1 UML DIAGRAM

2.2 Permission Codes

The resource requires the ReadProducts permission. The resource response payload does not differ depending on the permissions granted.

2.3 Data Dictionary

_Name	_Occurrence	_XPath	_{EnhancedDefinition}	_Class	_Codes	_Pattern
_{OBReadProduct}		_{OBReadProduct}		_{OBReadProduct}
_Data	_1..1	_{OBReadProduct/Data}		_{OBReadProduct/Data}
_CASA	_0..n	_{OBReadProduct/Data/CASA}		_{OBReadProduct/Data/CASA}
_{AccountNumber}	_1..1	_{OBReadProduct/Data/CASA/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)}	_String
_{ProductTypeDescription}	_1..1	_{OBReadProduct/Data/CASA/ProductTypeDescription}	_{Full description of the product}	_String
_AccountName	_1..1	_{OBReadProduct/Data/CASA/AccountName}	_{Full account name}	_String
_BranchName	_1..1	_{OBReadProduct/Data/CASA/BranchName}	_{Branch Name}	_String
_{AccountStatus}	_1..1	_{OBReadProduct/Data/CASA/AccountStatus}	_{One of ‘active’/’inactive’/'dormant'/’frozen’ (A/I/D/F)}	_String
_{AccountClosed}	_1..1	_{OBReadProduct/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}	_{Lien amount marked}	_String
_IBAN	_1..1	_{OBReadProduct/Data/CASA/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.000}	_String
_{AccountOpeningDate}	_1..1	_{OBReadProduct/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/JointHoldersCPRs}	_{List of joint account holder CPRs}	_String
_Investment	_0..n	_{OBReadProduct/Data/Investment}		_{OBReadProduct/Data/Investment}
_{AccountNumber}	_1..1	_{OBReadProduct/Data/Investment/AccountNumber}	_{Bank Account number}	_String
_AccountType	_1..1	_{OBReadProduct/Data/Investment/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}	_String
_AccountName	_1..1	_{OBReadProduct/Data/Investment/AccountName}	_{Full account name}	_String
_BranchName	_1..1	_{OBReadProduct/Data/Investment/BranchName}	_{Branch Name}	_String
_{AccountStatus}	_1..1	_{OBReadProduct/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
_{MaturityAmount}	_1..1	_{OBReadProduct/Data/Investment/MaturityAmount}	_{Maturity Amount}	_String
_MaturityDate	_1..1	_{OBReadProduct/Data/Investment/MaturityDate}	_{Maturity Date}	_DateTime
_IBAN	_1..1	_{OBReadProduct/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}	_{List of joint account holder CPRs}	_String
_Loans	_0..n	_{OBReadProduct/Data/Loans}		_{OBReadProduct/Data/Loans}
_{AccountNumber}	_1..1	_{OBReadProduct/Data/Loans/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}	_1..1	_{OBReadProduct/Data/Loans/AccountCurrency}	_{Currency code}	_String
_Rate	_1..1	_{OBReadProduct/Data/Loans/Rate}	_{Interest rate / profit rate for islamic banks}	_String
_LoanAmount	_1..1	_{OBReadProduct/Data/Loans/LoanAmount}	_{Initial Loan Amount}	_String
_{DisbursedAmount}	_1..1	_{OBReadProduct/Data/Loans/DisbursedAmount}	_{Disbursed Amount till date}	_String
_{OutstandingLoanAmount}	_1..1	_{OBReadProduct/Data/Loans/OutstandingLoanAmount}	_{Outstanding Loan Amount}	_String
_{Numberofinstallments}	_1..1	_{OBReadProduct/Data/Loans/Numberofinstallments}	_{Number of installments}	_String
_{LoanTerms - Months}	_1..1	_{OBReadProduct/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/JointHoldersCPRs}	_{List of joint account holder CPRs}	_String
_CreditCards	_0..n	_{OBReadProduct/Data/CreditCards}		_{OBReadProduct/Data//CreditCards}
_CardNumber	_1..1	_{OBReadProduct/Data/CreditCards/CardNumber}	_{Card Number}	_String
_CardIssuer	_1..1	_{OBReadProduct/Data/CreditCards/CardIssuer}	_{Card Issuer}	_String
_CardType	_1..1	_{OBReadProduct/Data/CreditCards/CardType}	_{Card Type}	_String
_{ProductTypeDescription}	_1..1	_{OBReadProduct/Data/CreditCards/ProductTypeDescription}	_{Product type description}	_String
_CardName	_1..1	_{OBReadProduct/Data/CreditCards/CardName}	_{Card Name}	_String
_BranchName	_1..1	_{OBReadProduct/Data/CreditCards/BranchName}	_{Branch Name}	_String
_CardStatus	_1..1	_{OBReadProduct/Data/CreditCards/CardStatus}	_{Card status}	_String
_CardClosed	_1..1	_{OBReadProduct/Data/CreditCards/CardClosed}	_{Card Closed}	_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

A. Specific Account

GET /accounts/22289/product
Authorisation: 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

Get Product Response

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

{

"Data": {

"CASA": [

{

"AccountNumber": "22289",

"AccountType": "Savings Account",

"ProductTypeDescription": "A financial account held by the individuals for carrying out transaction on a regular basis",

"AccountName": "Asif Khan",

"BranchName": "Manama",

"AccountStatus": "A",

"AccountClosed": "N",

"AccountCurrency": "BHD",

"AvailableBalance": "190000 BHD",

"EffectiveAvailableBalance": "150000 BHD",

"LienAmount": "1000 BHD",

"IBAN": "BH10BBKU00100000008876",

"ExchangeRate": "1",

"AccountOpeningDate": "2019-04-22T07:07:54.469+03:00",

"AccountClosingDate": "2032-04-22T07:07:54.469+03:00",

"JointHoldersCPRs": "NA"

}

]

}

B. Bulk Account

Get Products Request

GET /products
Authoriszation: 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

Get Products Response

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

{
  "Data": {
    "CASA": [
      {
        "AccountNumber": "22289",
        "AccountType": "Savings Account",
        "ProductTypeDescription": "A financial account held by the individuals for carrying out transaction on a regular basis",
        "AccountName": "Asif Khan",
        "BranchName": "Manama",
        "AccountStatus": "A",
        "AccountClosed": "N",
        "AccountCurrency": "BHD",
        "AvailableBalance": "190000 BHD",
        "EffectiveAvailableBalance": "150000 BHD",
        "LienAmount": "1000 BHD",
        "IBAN": "BH10BBKU00100000008876",
        "ExchangeRate": "1",
        "AccountOpeningDate": "2019-04-22T07:07:54.469+03:00",
        "AccountClosingDate": "2032-04-22T07:07:54.469+03:00",
        "JointHoldersCPRs": "NA"
      }
    ],

    "Investment": [
      {
        "AccountNumber": "38980",
        "AccountType": "Current Account",
        "ProductTypeDescription": "A financial account held by the individuals that contains products related to short term and long term investments such as deposit of funds, securities, etc.",
        "AccountName": "Infra Limited",
        "BranchName": "Manama",
      "AccountStatus": "A",
        "AccountClosed": "N",
        "AccountCurrency": "BHD",
        "Rate": "8.00%",
        "InitialDepositAmount": "100000 BHD",
        "DepositTerms-Months": "12",
        "DepositTerms-Days": "0",
        "MaturityAmount": "108000 BHD",
        "MaturityDate": "2020-10-22T07:07:54.469+03:00",
        "IBAN": "BH10CBBU00100000001356",
        "ExchangeRate": "1",
        "AccountOpeningDate": "2019-04-22T07:07:54.469+03:00",
        "AccountClosingDate": "2032-04-22T07:07:54.469+03:00",
        "JointHoldersCPRs": "NA"
      }
    ]
  }

}

Products