| Table of Contents | ||||
|---|---|---|---|---|
|
1. Overview
The supplementary account info resource is used by an AISP to retrieve the account product information for a specific AccountId.
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.1 | supplementary-account-info | GET | GET /accounts/{AccountId}/supplementary-account-info | Optional | accounts | Authorisation Code | No | OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
2.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). This endpoint is marked as Optional for ASPSPs.
3. Data Model
The OBReadSupplementaryAccountInfo OBReadSupplementaryAccountInfo object will be used for the call to:
GET /accounts/{AccountId}/supplementary-account-info
3.1 UML Diagram
3.2 Permission Codes
The resource requires the 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 |
OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfoOBReadSupplementaryAccountInfo |
| OBReadSupplementaryAccountInfo |
|
|
Data | 1..1 | OBReadSupplementaryAccountInfo/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 |
|
|
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:
|
|
MaturityAmount | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /MaturityAmount | Maturity Amount. | String |
|
|
MaturityDate | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /MaturityDate | Maturity Date. | DateTime |
|
|
JointHolderName | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ReadDepositInfo /JointHolderName | List of joint account holder name. | String |
|
|
ReadLoanMortgageInfo | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo |
| OBReadSupplementaryAccountInfo/Data/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 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /LoanAmount | Initial Loan Amount issued to the account. | String |
|
|
DisbursedAmount | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /DisbursedAmount | Disbursed Amount till date to the account. | String |
|
|
OutstandingLoanAmount | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /OutstandingLoanAmount | Outstanding Loan Amount. | String |
|
|
Numberofinstallments | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /Numberofinstallments | Number of instalments. | String |
|
|
LoanFrequency | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /LoanFrequency | Regularity with which the instalment is applied to the Account. | String | Enum:
|
|
JointHolderName | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadLoanMortgageInfo /JointHolderName | List of joint account holder name. | String |
|
|
ReadCreditCardInfo | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadCreditCardInfo |
| OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadCreditCardInfo |
|
|
Rate | 1..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadCreditCardInfo /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 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadCreditCardInfo /CardLimit | Credit Limit applied to the account. | String |
|
|
GracePeriod | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadCreditCardInfo/ GracePeriod | The duration after the due date during which the payment can be received without penalty. | String |
|
|
URL | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadCreditCardInfo/URL | Uniform resource locator of the specified product. | String |
|
|
ReadEWalletInfo | 0..1 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadEWalletInfo |
| OBReadSupplementaryAccountInfo/Data/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 | OBReadSupplementaryAccountInfo/Data/ReadAccount/ ReadEWalletInfo/ChargeFrequency | Regularity with which the fee is applied to the Account. | String | Enum:
|
|
4. Usage Example
4.1 Get Supplementary Account Info
4.1.1 Request
|
4.1.2 Response
|
|
CENTRAL BANK OF BAHRAIN © 2020