| Table of Contents | ||||
|---|---|---|---|---|
|
1. Overview
The product 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.
2. 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 |
2.1products | supplementary-account-info | GET | GET /accounts/{AccountId}/productConditionalsupplementary-account-info | Optional | accounts | Authorization Authorisation Code | No | OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
...
2
...
products
...
GET
...
GET /products
...
Optional
...
accounts
...
Authorization Code
...
No
...
Pagination
...
...
OBReadProduct
...
.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
3. Data Model
...
3. Data Model
The OBReadSupplementaryAccountInfo OBReadSupplementaryAccountInfo object will be used for the call to:
GET /accounts/{AccountId}/product
GET /products
supplementary-account-info
3.1 UML Diagram
...
3.2 Permission Codes
The resource requires the ReadProducts ReadSupplementaryAccountInfo permission. The resource response payload does not differ depending on the permissions granted.
3.3 Data Dictionary
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern | ||||||||||||||||||
OBReadProductOBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadProductOBReadSupplementaryAccountInfo |
| OBReadProduct | ||||||||||||||||||
Data | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data |
| OBReadProductOBReadSupplementaryAccountInfo/Data |
|
| ||||||||||||||||||
CASAReadAccount | 0..n1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount |
| OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount |
|
| ||||||||||||||||||
AccountID | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/AccountID | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String |
|
| ||||||||||||||||||
AccountType DateTime | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/AccountType | Type of account as classified by the ASPSP (eg. Savings Account, Current account) | String | ProductTypeDescription | 1DateTime | Date on which the account and related basic services are effectively operational for the account owner. | DateTime |
|
| ||||||||||||||
ReadCASAInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/ProductTypeDescription | Full description of the product | String | Name | 1..1 | OBReadProduct/Data/CASA/Name | Full name of the account holder | String | BranchName | 1ReadCASAInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo |
|
| |||||||||
LienAmount | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/ReadCASAInfo /BranchName Branch NameLienAmount | Lien amount marked. | String |
|
| ||||||||||||||||||
AccountStatus Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/CASAReadCASAInfo /AccountStatus Rate | Specifies Rate charged for the status of account resource in code form. | String | AccountClosed | 1account (where it is charged in terms of a rate rather than an amount) | String |
|
| |||||||||||||||
JointHolderName | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/CASAReadCASAInfo /AccountClosed | Y or N | String | Currency | 1JointHolderName | List of joint account holder name. | String |
|
| ||||||||||||||
ReadDepositInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/Currency | Identification of the currency in which the account is held. | String | AvailableBalance | 1..1 | OBReadProductReadDepositInfo |
| OBReadSupplementaryAccountInfo/Data/CASAReadAccount/AvailableBalance | Withdrawable balance + funds in clearing | String | EffectiveAvailableBalance ReadDepositInfo |
|
| ||||||||||
Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/CASAReadDepositInfo /EffectiveAvailableBalance | Withdrawable balance | String | LienAmount | 0Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String |
|
| ||||||||||||||
InitialDepositAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/CASAReadDepositInfo /LienAmount InitialDepositAmount | Lien Initial deposit amount marked. | String |
|
| ||||||||||||||||||
ExchangeRate DepositFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/ReadDepositInfo /ExchangeRate | Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). | String | AccountOpeningDate | 1..1 | OBReadProduct/Data/CASA/AccountOpeningDate | Account opening date | DateTime | AccountClosingDate DepositFrequency | Regularity with which deposit are made/processed to the account | String | Enum:
|
| ||||||||||
MaturityAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CASAReadAccount/ReadDepositInfo /AccountClosingDate | If the account is closed then Account closed date should be available. | DateTime | JointHoldersNameMaturityAmount | Maturity Amount. | String |
|
| |||||||||||||||
MaturityDate | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /MaturityDate | Maturity Date. | DateTime |
|
| ||||||||||||||||||
JointHolderName | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/CASAReadDepositInfo /JointHoldersNameJointHolderName | List of joint account holder name. | String |
| Investment | ||||||||||||||||||
ReadLoanMortgageInfo | 0..n1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadLoanMortgageInfo |
| OBReadProductOBReadSupplementaryAccountInfo/Data/InvestmentAccountID/ReadAccount/ ReadLoanMortgageInfo |
|
| ||||||||||||||||||
Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadLoanMortgageInfo /AccountID | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String | AccountType Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String |
|
| |||||||||||||||
LoanAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/InvestmentReadAccount/ ReadLoanMortgageInfo /AccountType | Type of account as classified by the ASPSP (eg. Savings Account, Current account) | String | ProductTypeDescription | 1LoanAmount | Initial Loan Amount issued to the account. | String |
|
| ||||||||||||||
DisbursedAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadLoanMortgageInfo /ProductTypeDescription | Full description of the product | String | Name DisbursedAmount | Disbursed Amount till date to the account. | String |
|
| |||||||||||||||
OutstandingLoanAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadLoanMortgageInfo /Name | Full name of the account holder | String | BranchName OutstandingLoanAmount | Outstanding Loan Amount. | String |
|
| |||||||||||||||
Numberofinstallments | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/InvestmentReadAccount/ BranchName Branch NameReadLoanMortgageInfo /Numberofinstallments | Number of instalments. | String |
| AccountStatus | ||||||||||||||||||
LoanFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadLoanMortgageInfo /AccountStatus Specifies the status of account resource in code formLoanFrequency | Regularity with which the instalment is applied to the Account. | StringAccountClosed | Enum:1
| OBReadProduct/Data/Investment/AccountClosed | Y or N | String | Currency | 1
|
| |||||||||||||
JointHolderName | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadLoanMortgageInfo /Currency JointHolderName | Identification of the currency in which the account is heldList of joint account holder name. | String |
|
| ||||||||||||||||||
Rate ReadCreditCardInfo | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/InvestmentReadAccount/ Rate | Interest rate / profit rate for islamic banks | String | InitialDepositAmount | 1..1 | OBReadProductReadCreditCardInfo |
| OBReadSupplementaryAccountInfo/Data/InvestmentReadAccount/ InitialDepositAmount ReadCreditCardInfo | Initial deposit amount | String | |||||||||||||
DepositTerms- Months Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadCreditCardInfo /DepositTerms- Months | Deposit terms in months (in case of years convert to months) | String | DepositTerms - Days Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String |
|
| |||||||||||||||
CardLimit | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadCreditCardInfo /DepositTerms - Days Deposit term in daysCardLimit | Credit Limit applied to the account. | String | MaturityAmount | 1 |
| |||||||||||||||||
GracePeriod | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadCreditCardInfo/ MaturityAmount | Maturity Amount | String | MaturityDate | 1GracePeriod | The duration after the due date during which the payment can be received without penalty. | String |
|
| ||||||||||||||
URL | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ InvestmentReadCreditCardInfo/MaturityDate | Maturity Date | DateTime | ExchangeRate | 1URL | Uniform resource locator of the specified product. | String |
|
| ||||||||||||||
ReadEWalletInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadEWalletInfo |
| OBReadSupplementaryAccountInfo/Data/Investment/ExchangeRate | Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). | String | AccountOpeningDate ReadAccount/ ReadEWalletInfo |
|
| |||||||||||||||
Charge | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadEWalletInfo/Charge | Fee charged for the account (where it is charged in terms of an amount)
| String |
|
| ||||||||||||||||||
ChargeFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/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 | JointHoldersName | 0..1 | OBReadProduct/Data/Investment/JointHoldersName | List of joint account holder name | String | Loans | 0..n | OBReadProduct/Data/Loans |
| OBReadProduct/Data/Loans | AccountID ReadAccount/ ReadEWalletInfo/ChargeFrequency | Regularity with which the fee is applied to the Account. | String | Enum:
|
|
OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfo |
|
| ||||||||||||||||||
Data | 1..1 | OBReadProduct/Data/Loans/AccountIDOBReadSupplementaryAccountInfo/Data |
| OBReadSupplementaryAccountInfo/Data |
|
| ||||||||||||||||||
ReadAccount | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount |
| OBReadSupplementaryAccountInfo/Data/ReadAccount |
|
| ||||||||||||||||||
AccountID | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/AccountID | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String |
|
| ||||||||||||||||||
LoanType DateTime | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/LoanType | Type of loan as classified by the ASPSP | String | ProductTypeDescription | 1DateTime | Date on which the account and related basic services are effectively operational for the account owner. | DateTime |
|
| ||||||||||||||
ReadCASAInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ProductTypeDescription | Full description of the product | String | Name | 1..1 | OBReadProduct/Data/Loans/Name | Full name of the account holder | String | BranchName | 1ReadCASAInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo |
|
| |||||||||
LienAmount | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ReadCASAInfo /BranchName Branch NameLienAmount | Lien amount marked. | String |
|
| ||||||||||||||||||
AccountStatus Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ReadCASAInfo /AccountStatus Rate | Specifies Rate charged for the status of account resource in code form. | String | AccountClosed | 1account (where it is charged in terms of a rate rather than an amount) | String |
|
| |||||||||||||||
JointHolderName | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/LoansReadCASAInfo /AccountClosed | Y or N | String | Currency | 1JointHolderName | List of joint account holder name. | String |
|
| ||||||||||||||
ReadDepositInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Loans/Currency | Identification of the currency in which the loan is held. | StringReadAccount/ReadDepositInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo |
|
| ||||||||||||||||
Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Loans/Rate ReadAccount/ReadDepositInfo /Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String | LoanAmount |
| ||||||||||||||||||
InitialDepositAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/LoansReadDepositInfo /LoanAmount InitialDepositAmount | Initial Loan Amountdeposit amount. | String |
| DisbursedAmount | ||||||||||||||||||
DepositFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ReadDepositInfo /DisbursedAmount Disbursed Amount till dateDepositFrequency | Regularity with which deposit are made/processed to the account | StringOutstandingLoanAmount | Enum:1
| OBReadProduct/Data/Loans/OutstandingLoanAmount | Outstanding Loan Amount | String | Numberofinstallments
|
| ||||||||||||||
MaturityAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/LoansReadDepositInfo /Numberofinstallments Number of installmentsMaturityAmount | Maturity Amount. | StringLoanTerms - Months |
|
| ||||||||||||||||||
MaturityDate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Loans/LoanTerms - Months | Deposit terms in months (in case of years convert to months) | String | DepositTerms - Days | 1ReadAccount/ReadDepositInfo /MaturityDate | Maturity Date. | DateTime |
|
| ||||||||||||||
JointHolderName | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/LoansReadDepositInfo /DepositTerms - Days Deposit term in daysJointHolderName | List of joint account holder name. | String | ExchangeRate | 1 |
| |||||||||||||||||
ReadLoanMortgageInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo |
| OBReadSupplementaryAccountInfo/Data/Loans/ExchangeRate | Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). | String | AccountOpeningDate ReadAccount/ ReadLoanMortgageInfo |
|
| |||||||||||||||
Rate | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String |
|
| ||||||||||||||||||
LoanAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/Loans/AccountOpeningDate | Account opening date | DateTime | AccountClosingDate ReadAccount/ ReadLoanMortgageInfo /LoanAmount | Initial Loan Amount issued to the account. | String |
|
| |||||||||||||||
DisbursedAmount | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/LoansReadAccount/ ReadLoanMortgageInfo /AccountClosingDate | If the account is closed then Account closed date should be available. | DateTime | JointHoldersName | 0..1 | OBReadProduct/Data/Loans/JointHoldersName | List of joint account holder name | String | CreditCards | 0..n | OBReadProduct/Data/CreditCards |
| OBReadProduct/Data//CreditCards | CardNumber DisbursedAmount | Disbursed Amount till date to the account. | String |
|
| |||||
OutstandingLoanAmount | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /OutstandingLoanAmount | Outstanding Loan Amount. | String |
|
| ||||||||||||||||||
Numberofinstallments | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadLoanMortgageInfo /CardNumber | Card number (Masked card details) | String | CardIssuer Numberofinstallments | Number of instalments. | String |
|
| |||||||||||||||
LoanFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadLoanMortgageInfo /CardIssuer Card issuer (e.g VISA)LoanFrequency | Regularity with which the instalment is applied to the Account. | StringCardType | Enum:1
| OBReadProduct/Data/CreditCards/CardType | Primary or Secondary | String | ProductTypeDescription | 1
|
| |||||||||||||
JointHolderName | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadLoanMortgageInfo /ProductTypeDescription JointHolderName | Full description of the product | String | Name | 1List of joint account holder name. | String |
|
| |||||||||||||||
ReadCreditCardInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ Name ReadCreditCardInfo | Full Name | String | BranchName | 1..1 | OBReadProduct | OBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ BranchName ReadCreditCardInfo | Branch Name | String | ||||||||||||||
CardStatus Rate | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadCreditCardInfo /CardStatus Rate | Specifies the status of card resource in code formRate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String | CardClosed |
| ||||||||||||||||||
CardLimit | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadCreditCardInfo /CardClosed Y or NCardLimit | Credit Limit applied to the account. | String |
| Currency | ||||||||||||||||||
GracePeriod | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCardsReadCreditCardInfo/ Currency Identification of the currency in which the account is heldGracePeriod | The duration after the due date during which the payment can be received without penalty. | String |
| CardBalance | ||||||||||||||||||
URL | 10..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ ReadCreditCardInfo/CardBalance | Card Balance | String | Rate | 1URL | Uniform resource locator of the specified product. | String |
|
| ||||||||||||||
ReadEWalletInfo | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ Rate | Interest rate / profit rate for islamic banks | String | CardLimit ReadEWalletInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadEWalletInfo |
|
| |||||||||||||||
Charge | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/ReadAccount/ CreditCards/CardLimit | Card Limit | String | MinimumDueReadEWalletInfo/Charge | Fee charged for the account (where it is charged in terms of an amount)
| String |
|
| |||||||||||||||
ChargeFrequency | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/ ReadEWalletInfo/MinimumDue Minimum Amount payableChargeFrequency | Regularity with which the fee is applied to the Account. | StringTotalDue | Enum:1
| OBReadProduct/Data/CreditCards/TotalDue | Total Amount payable | String | PaymentDueDate | 1..1 | OBReadProduct/Data/CreditCards/PaymentDueDate | Payment Due date | DateTime | AddOnCards | 1..1 | OBReadProduct/Data/CreditCards/AddOnCards | Number of add-on cards (supplementary cards) | String | ExchangeRate
|
| ||||
OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfo |
|
| ||||||||||||||||||
Data | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCards/ ExchangeRate | Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). | String | CardIssueDate | 1 |
| OBReadSupplementaryAccountInfo/Data |
|
| ||||||||||||||
ReadAccount | 0..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCards/CardIssueDate | Card Issue date | DateTime | CardClosingDateReadAccount |
| OBReadSupplementaryAccountInfo/Data/ReadAccount |
|
| |||||||||||||||
AccountID | 1..1 | OBReadProductOBReadSupplementaryAccountInfo/Data/CreditCardsReadAccount/CardClosingDate | If the Card is closed then Account closed date should be available. | DateTime |
4. Usage Example
4.1 Specific Account
4.1.1 Request
|
4.1.2 Response
|
|
4.2 Bulk Account
4.2.1 Get Products Request
|
4.2.2 Get Products Response
|
AccountID | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String |
|
| ||
DateTime | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/DateTime | Date on which the account and related basic services are effectively operational for the account owner. | DateTime |
|
|
ReadCASAInfo | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo |
|
|
LienAmount | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo /LienAmount | Lien amount marked. | String |
|
|
Rate | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo /Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) | String |
|
|
JointHolderName | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadCASAInfo /JointHolderName | List of joint account holder name. | String |
|
|
ReadDepositInfo | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo |
|
|
Rate | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /Rate | Rate charged for the account (where it is charged in terms of a rate rather than an amount) Interest rate / profit rate for islamic banks. | String |
|
|
InitialDepositAmount | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /InitialDepositAmount | Initial deposit amount. | String |
|
|
DepositFrequency | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /DepositFrequency | Regularity with which deposit are made/processed to the account | String | Enum:
|
|
4. Usage Example
4.1 Get Supplementary Account Info
4.1.1 Request
|
4.1.2 Response
|
|