Balance
Get a single or multiple account balances
Get All Accounts Balances
This method fetches account balances of all the accounts included in the specified consent ID.
Endpoint details
| Endpoint URL | Method | Grant type | Scope |
|---|---|---|---|
/v1/api/observice/allAccountsBalance | POST | The header should include: 1. signature2. Authorization: Bearer Token | Fetch account balance 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": "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 |
Get Account Balance by Account ID
This method retrieves the specific account balances by using the account ID included in the request.
Endpoint details
| Endpoint URL | Method | Grant type | Scope |
|---|---|---|---|
/v1/api/observice/balanceById | POST | The header should include: 1. signature2. Authorization: Bearer Token | Fetch account balance information of the specific bank account using the 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 account identification as per the consent | String |
Sample response
{
"success": true,
"payload": [
{
"code": "Bank_Code",
"data": {
"accountId": "Account_Id",
"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"
}
}
]
}
]
},
"links": {
"self": "https://"
},
"meta": {
"totalPages": 0
}
}
]
}
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 account and balance data included in the response |
| accountId | Unique account identification |
| 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 |
| links | Redirect link |
| self | Own link/URL details |
| meta | Meta tag |
| totalPages | Information displayed in terms of pages |
Updated 4 days ago