Balance Check
Get account balance updates in real-time
Introduction
Balance Check API services provide access to real-time balance information for specific bank accounts included in the Consent ID. Viewing multiple account balances in real time is helpful in budgeting, payment processing, and account management. SingleView's user-friendly integration options and security measures make our API services a valuable resource for businesses and individuals to stay informed about their financial positions.
Balance Check API services allow you to fetch single or multiple account balances in real time.
Consent
User consent is the primary requirement to access any services in Open Banking. The user or account holder grants explicit consent to a Third-Party to access their financial data. This consent is given through a secure, multi-factor authentication process to verify the user's identity.
The consent request must include the following details:
| Endpoint | useCaseType Value | permissions Value |
|---|---|---|
/v1/api/observice/connect | BALANCECHECK | ReadAccountsBasicReadAccountsDetailReadBalances |
Check Consent Management for more details to create, view, and revoke consents.
Get Balance Check Services
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/v1/api/observice/allAccountsBalance | POST | 1. clientId 2. clientCode 3. signature 4. Authorization Bearer: Token |
Sample request
{
"dateTimeStamp": "YYYY-MM-DDTHH:MM:SS",
"requestID": "Enter_Request_Id",
"merchantId": "Enter_Merchant_Id",
"fromDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"toDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"balanceCheck" : true,
"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 |
| fromDate Mandatory | Initial date of transaction period | String |
| toDate Mandatory | Final date of transaction period | String |
| balanceCheck Mandatory | Balance check service tag to be denoted as true | Boolean |
| 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": "Account_Status",
"currency": "Account_Currency",
"nickname": "Account_Nickname",
"accountType": "Account_Type",
"accountSubType": "Account_Sub_Type",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
}
],
"servicer": {
"identificationType": "Servicer_Identification_Type",
"identification": "Servicer_Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"balance": [
{
"amount": {
"amount": "0000.00",
"currency": "Currency"
},
"creditDebitIndicator": "Credit_or_Debit",
"type": "Type_Indicator",
"dateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"creditLine": [
{
"included": true,
"type": "Credit_Line_Type",
"amount": {
"amount": "0000.00",
"currency": "Currency"
}
}
]
}
]
},
{
"accountId": "Account_Id",
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Account_Status",
"currency": "Account_Currency",
"nickname": "Account_Nickname",
"accountType": "Account_Type",
"accountSubType": "Account_Sub_Type",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
}
],
"servicer": {
"identificationType": "Servicer_Identification_Type",
"identification": "Servicer_Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"balance": [
{
"amount": {
"amount": "0000.00",
"currency": "Currency"
},
"creditDebitIndicator": "Credit_or_Debit",
"type": "Type_Indicator",
"dateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"creditLine": [
{
"included": true,
"type": "Credit_Line_Type",
"amount": {
"amount": "0000.00",
"currency": "Currency"
}
}
]
}
]
},
{
"accountId": "Account_Id",
"accountHolderName": "Account_Holder_Name",
"accountHolderShortName": "Account_Holder_Short_Name",
"status": "Account_Status",
"currency": "Account_Currency",
"nickname": "Account_Nickname",
"accountType": "Account_Type",
"accountSubType": "Account_Sub_Type",
"accountIdentifiers": [
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
},
{
"identificationType": "Identification_Type",
"identification": "Identification_Details",
"name": "Name"
}
],
"servicer": {
"identificationType": "Servicer_Identification_Type",
"identification": "Servicer_Identification"
},
"statusUpdateDateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"description": "Account_Description",
"openingDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"maturityDate": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"balance": [
{
"amount": {
"amount": "0000.00",
"currency": "Currency"
},
"creditDebitIndicator": "Credit_or_Debit",
"type": "Type_Indicator",
"dateTime": "YYYY-MM-DDTHH:MM:SS.SSSZ",
"creditLine": [
{
"included": true,
"type": "Credit_Line_Type",
"amount": {
"amount": "0000.00",
"currency": "Currency"
}
}
]
}
]
}
],
"totalOpeningBalance": "0000",
"totalAvailableBalance": "0000",
"totalClosingAvailable": "0000",
"currency": "Currency"
},
"links": {
"self": "https://"
},
"meta": {
"totalPages": 0
}
}
],
"overAllBalance": {
"totalOpeningBalance": "0000",
"totalAvailableBalance": "0000",
"totalClosingAvailable": "0000",
"currency": "Currency"
}
}
Response description
| JSON Tag | Description |
|---|---|
| success | Process success status represented as True or False |
| payload | Payload tag carrying response information |
| code | Unique bank code identification |
| data | Tag carrying accounts and balances data included in the response |
| accountId | Unique account identification |
| accountHolderName | Name of the account holder |
| accountHolderShortName | Short name of the account holder |
| status | Status of the account |
| currency | Default currency of the account |
| nickname | Nickname of the account |
| accountType | Details of account type |
| accountSubType | Details of account sub-type |
| accountIdentifiers | Tag carrying account identifiers details |
| identificationType | Account identification type details |
| identification | Account identification details |
| name | Name of the account identifier |
| servicer | Tag carrying account servicer details |
| identificationType | Servicer identification type details |
| identification | Servicer identification details |
| statusUpdateDateTime | Last time and date of update for account information |
| description | Description of the update |
| openingDate | Opening date of the account |
| maturityDate | Maturity date of the account |
| balance | Tag carrying account balance information |
| amount | Tag carrying cash balance information |
| amount | Cash balance amount |
| currency | Default currency of the account in which the balance is indicated |
| creditDebitIndicator | Indicates whether the balance is a credit or a debit balance |
| type | Indicator type details |
| dateTime | Date and time information of the indicator |
| creditLine | Tag carrying credit line information |
| included | Status of credit line as included or excluded |
| type | Type of credit line details |
| amount | Tag carrying amount information of credit line |
| amount | Available amount in credit line |
| currency | Currency in which the credit line balance is indicated |
| totalOpeningBalance | Total opening balance |
| totalAvailableBalance | Total available balance |
| totalClosingAvailable | Total closing balance |
| currency | Currency of the total balances |
| links | Redirect link |
| self | Own link/URL details |
| meta | Meta tag |
| totalPages | Information displayed in terms of pages |
| overallBalance | Tag carrying information on overall balances |
| totalOpeningBalance | Total opening balance |
| totalAvailableBalance | Total available balance |
| totalClosingBalance | Total closing balance |
| currency | Currency of the overall balance indicated |
Updated 6 months ago