Accounts
Get a single or multiple accounts information
Overview
SingleView AIS API enables the retrieving of account information from the banks using the Consent ID and account ID. The API allows the users to access the account information for the Bank accounts that hold an active user consent. Once a consent is expired or is deleted, that specific bank account information shall be unavailable to access.
For all the consented bank accounts, there exists unique account ID that can be used to retrieve the corresponding account information and data.
Thus account information can be obtained in the following methods:
- Get All Accounts Info
- Get Account Info by Account ID
Get All Accounts Info
This method uses Consent ID and fetches all the bank accounts included in the specified consent. Below are the examples of request and response of this method.
Endpoint details
Endpoint URL | Method | Grant type | Scope |
---|---|---|---|
/v1/api/observice/accounts | POST | The header should include: 1. signature 2. Authorization: Bearer Token | Fetch accounts information of all the accounts included in the specified Consent ID |
Sample request
{
"dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
"requestID": "Enter_Request_Id",
"merchantId": "Enter_Merchant_Id",
"banks": [
{
"code": "Enter_Bank_Code",
"consentId":"Enter_Consent_Id"
}
]
}
Request description
JSON Tag | Description | Data type |
---|---|---|
DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
RequestID Mandatory | Unique request identification | String |
merchantId Mandatory | Unique merchant identification | String |
banks Mandatory | Array of banks and consents | Object |
code Mandatory | Unique bank identification code | String |
consentId Mandatory | Unique consent identification | String |
Sample response
{
"success": true,
"payload": [
{
"code": "Bank_Code",
"data": {
"account": [
{
"accountId": "Account_Id",
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Acccount_Status",
"currency": "Account_Currency",
"nickname": "Account_Holder_Nickname",
"accountType": "Type_of_Account",
"accountSubType": "Sub-Type_of_Account",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification",
"name": "Identified_Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification",
"name": "Identified_Name"
}
],
"servicer": {
"identificationType": "Identification_Type",
"identification": "Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Sub-type_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ"
},
{
"accountId": "Account_Id",
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Acccount_Status",
"currency": "Account_Currency",
"nickname": "Account_Holder_Nickname",
"accountType": "Type_of_Account",
"accountSubType": "Sub-Type_of_Account",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification",
"name": "Identified_Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification",
"name": "Identified_Name"
}
],
"servicer": {
"identificationType": "Identification_Type",
"identification": "Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Sub-type_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ"
}
]
},
"links": {
"self": "https://"
},
"meta": {
"totalPages": 0
}
}
]
}
Response description
JSON Tag | Description |
---|---|
success | Process success status represented as true or false |
payload | Tag carrying the response information |
code | Unique bank identification code |
data | Tag carrying the response data of the accounts |
account | Tag carrying a specific account information |
accountId | Unique bank account identification code |
accountHolderName | Full name of the account holder |
accountHolderShortName | Short name of the account holder |
status | Current status of the account as active or inactive |
currency | Default currency of the account |
nickname | Nickname of the account holder |
accountType | Type of the account |
accountSubType | Sub-type of the account |
accountIdentifiers | Account identifiers information tag |
identificationType | Type of account identification |
identification | Unique identification details |
name | Name of the account as per identification |
servicer | Account servicer details tag |
identificationType | Type of servicer account identification |
identification | Unique servicer identification details |
statusUpdateDateTime | Effective date and time of the last update of account information |
description | Description of the account information |
openingDate | Date of opening of the bank account |
maturityDate | Date of maturity of the bank account |
links | Redirect links tag |
self | Own links/url details |
meta | Meta tag |
totalPages | Information included in the response in terms of page length |
Get Account Info By Account ID
This method uses Consent ID and Account ID to fetch the account information of the specified account.
Endpoint details
Endpoint URL | Method | Grant type | Scope |
---|---|---|---|
/v1/api/observice/accountsById | POST | The header should include: 1. signature 2. Authorization: Bearer Token | Fetch account information of the specified account using Account ID |
Sample request
{
"dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
"requestID": "Enter_Request_Id",
"merchantId": "Enter_Merchant_Id",
"banks": [
{
"code": "Enter_Bank_Code",
"consentId":"Enter_Consent_Id",
"accountId": "Enter_Account_Id"
}
]
}
Request description
JSON Tag | Description | Data type |
---|---|---|
DateTimeStamp Mandatory | Stamp denoting the date and time of the request | String |
RequestID Mandatory | Unique request identification | String |
merchantId Mandatory | Unique merchant identification | String |
banks Mandatory | Array of banks and consents | Object |
code Mandatory | Unique bank identification code | String |
consentId Mandatory | Unique consent identification | String |
accountId Mandatory | Unique bank account identification included in the corresponding consent | String |
Sample response
{
"success": true,
"payload": [
{
"code": "Bank_Code",
"data": {
"accountId": "Account_Id",
"account": {
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Acccount_Status",
"currency": "Account_Currency",
"nickname": "Account_Holder_Nickname",
"accountType": "Type_of_Account",
"accountSubType": "Sub-Type_of_Account",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification",
"name": "Identified_Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification",
"name": "Identified_Name"
}
],
"servicer": {
"identificationType": "Identification_Type",
"identification": "Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Sub-type_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ"
}
},
"links": {
"self": "https://"
},
"meta": {
"totalPages": 0
}
}
]
}
Response description
JSON Tag | Description |
---|---|
success | Process success status represented as true or false |
payload | Tag carrying the response information |
code | Unique bank identification code |
data | Tag carrying the response data of the accounts |
accountId | Unique bank account identification as per the consent |
account | Tag carrying a specific account information |
accountHolderName | Full name of the account holder |
accountHolderShortName | Short name of the account holder |
status | Current status of the account as active or inactive |
currency | Default currency of the account |
nickname | Nickname of the account holder |
accountType | Type of the account |
accountSubType | Sub-type of the account |
accountIdentifiers | Account identifiers information tag |
identificationType | Type of account identification |
identification | Unique identification details |
name | Name of the account as per identification |
servicer | Account servicer details tag |
identificationType | Type of servicer account identification |
identification | Unique servicer identification details |
statusUpdateDateTime | Effective date and time of the last update of account information |
description | Description of the account information |
openingDate | Date of opening of the bank account |
maturityDate | Date of maturity of the bank account |
links | Redirect links tag |
self | Own links/url details |
meta | Meta tag |
totalPages | Information included in the response in terms of page length |
Updated 4 days ago