Other Product Data Model - v3.1.2

  1. Overview
    1. Fields to include in Other Product
    2. Data Model
      1. CreditInterest Model
      2. Overdraft
      3. OverdraftFeeCharges
      4. LoanInterest
      5. Repayment
      6. OtherFeesCharges
      7. SupplementaryData
    3. Data Payload
    4. Data Dictionary
    5. Data Payload - Enumerations
  2. Usage Examples
    1. Publish Other Product Type
      1. Get Accounts Product Request
      2. Get Accounts Product Response
    2. Publish Other Product Type along with Other Fee and Charges
      1. Get Accounts Product Request
      2. Get Accounts Product Response

Overview

From the analysis:-

  • Banks will provide the Open Data Product ID
  • In addition to the “Open Data Product ID” link, we should focus on fields that are provided by price comparison websites today. Each product type may have completely different set of fields, like Mortgages , Insurance or Islamic Banking. It may not be possible to publish complete product details using the generic structure.
  • The generic structure supports the publishing of key feature of Other Product Type

Further analysis required:-

  • Further analysis is required to elaborate key features of other supported products. Generic Data Model just supports the publishing of very basic features.

Fields to include in Other Product

Product SectionFields to be included
ProductDetails<li>Name <li>Segmeent <li>Notes to capture other details
CreditInterest<li>TierBandSet fields (excluding credit interest eligibility). <li>All TierBand fields
LoanInterest<li>TierBandSet fields. <li>All TierBand fields
Repayment<li>Repayment Charges <li>Repayment holiday
OtherFeesAndCharges<li>Other fee charges such as servicing
SupplementaryDataAny other feature of the product which cant be published using above functionality.

Data Model

 OtherProductInfoMainPage.png

CreditInterest Model

  • A generic data model to publish the Credit Interest functionality if applicable to Other Product Type.

 OtherProductInfoCreditInterest.png

Overdraft

  • A generic structure for Overdraft published only if applicable to Other Product Type .

OverdraftFeeCharges

  • A generic structure for Overdraft Fee Charges published only if applicable to Other Product Type .

 OtherProductInfoOverdraft.png

LoanInterest

  • A generic structure for Loan Interest published only if applicable to Other Product Type .

 OtherProductInfoLoanInterest.png

Repayment

  • A generic structure for Loan Repayment along with Fee Charges published only if applicable to Other Product Type.

 OtherProductInfoRepayment.png

OtherFeesCharges

  • A generic structure for Other Fee Charges published only if applicable to Other Product Type.

 OtherProductInfoOtherFeesCharges.png

SupplementaryData

SupplementaryData allows to publish features or functionality that is not catered for by other sections of the data model. The Supplementary Data section is defined as an empty JSON object in the specification. Wherever used, an ASPSP must define and document (on their developer portal) their own structure, usage and (mandatory/optional) requirements for Supplementary Data.  OtherProductInfoSupplementaryData.png

Data Payload

 OtherProductInfo.png

Data Dictionary

Data Payload - Enumerations

Usage Examples

Publish Other Product Type

Example reference HSBC Basic Saving Account

Get Accounts Product Request

GET /accounts/22389/product HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Get Accounts Product Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
  "Data": {
    "Product": [
      {
        "AccountId": "22389",
        "ProductId": "HSBC12234BAS",
        "ProductType": "Othert",
        "ProductName": "HSBC Basic Saving Account",
        "OtherProductType": {
          "Name": "BasicSavingAccount",
          "Description": "HSBC fee free saving basic saving account"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/product"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Publish Other Product Type along with Other Fee and Charges

The example below has been taken from HSBC saving account. The example is purely madeup data for illustration purpose only.

Get Accounts Product Request

GET /accounts/22390/product HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

Get Accounts Product Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
  "Data": {
    "Product": [
      {
        "AccountId": "22390",
        "ProductId": "HSBC12234BAS",
        "ProductType": "Other",
        "ProductName": "Saving Account No Monthly Fee",
        "OtherProductType": {
          "Name": "BasicSavingAccount",
          "Description": "HSBC fee free saving basic saving account"
          "OtherProductDetails": {
            "OtherFeesCharges": {
              "FeeChargeDetail": [
                {
                  "FeeCategory": "Servicing",
                  "FeeType": "ServiceCAccountFeeMonthly",
                  "FeeAmount": "12.500",
                  "ApplicationFrequency": "Monthly",
                  "CalculationFrequency": "Daily",
                  "Notes": [
                    "Our tariff includes:\n* depositing and sending cheques\n* cash deposits up to the limit your tariff allows\n* withdrawals\n* Direct Debits, standing orders, bill payments\n* Bas credits\n* debit card payments"
                  ]
                }
              ]
            }
          }
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22390/product"
  },
  "Meta": {
    "TotalPages": 1
  }
}