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 URLMethodGrant typeScope
/v1/api/observice/allAccountsBalancePOSTThe header should include:
1. signature
2. 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 TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString

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 TagDescription
successProcess success status represented as True or False
payloadPayload tag carrying response information
codeUnique bank code identification
dataTag carrying accounts and balances data included in the response
accountIdUnique account identification
accountHolderNameName of the account holder
accountHolderShortNameShort name of the account holder
statusStatus of the account
currencyDefault currency of the account
nicknameNickname of the account
accountTypeDetails of account type
accountSubTypeDetails of account sub-type
accountIdentifiersTag carrying account identifiers details
identificationTypeAccount identification type details
identificationAccount identification details
nameName of the account identifier
servicerTag carrying account servicer details
identificationTypeServicer identification type details
identificationServicer identification details
statusUpdateDateTimeLast time and date of update for account information
descriptionDescription of the update
openingDateOpening date of the account
maturityDateMaturity date of the account
balanceTag carrying account balance information
amountTag carrying cash balance information
amountCash balance amount
currencyDefault currency of the account in which the balance is indicated
creditDebitIndicatorIndicates whether the balance is a credit or a debit balance
typeIndicator type details
dateTimeDate and time information of the indicator
creditLineTag carrying credit line information
includedStatus of credit line as included or excluded
typeType of credit line details
amountTag carrying amount information of credit line
amountAvailable amount in credit line
currencyCurrency in which the credit line balance is indicated
totalOpeningBalanceTotal opening balance
totalAvailableBalanceTotal available balance
totalClosingAvailableTotal closing balance
currencyCurrency of the total balances
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages
overallBalanceTag carrying information on overall balances
totalOpeningBalanceTotal opening balance
totalAvailableBalanceTotal available balance
totalClosingBalanceTotal closing balance
currencyCurrency 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 URLMethodGrant typeScope
/v1/api/observice/balanceByIdPOSTThe header should include:
1. signature
2. 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 TagDescriptionData type
DateTimeStamp
Mandatory
Stamp denoting the date and time of the requestString
RequestID
Mandatory
Unique request identificationString
merchantId
Mandatory
Unique merchant identificationString
banks
Mandatory
Array of banks and consentsObject
code
Mandatory
Unique bank identification codeString
consentId
Mandatory
Unique consent identificationString
accountId
Mandatory
Unique account identification as per the consentString

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 TagDescription
successProcess success status represented as True or False
payloadPayload tag carrying response information
codeUnique bank code identification
dataTag carrying account and balance data included in the response
accountIdUnique account identification
balanceTag carrying account balance information
amountTag carrying cash balance information
amountCash balance amount
currencyDefault currency of the account in which the balance is indicated
creditDebitIndicatorIndicates whether the balance is a credit or a debit balance
typeIndicator type details
dateTimeDate and time information of the indicator
creditLineTag carrying credit line information
includedStatus of credit line as included or excluded
typeType of credit line details
amountTag carrying amount information of credit line
amountAvailable amount in credit line
currencyCurrency in which the credit line balance is indicated
linksRedirect link
selfOwn link/URL details
metaMeta tag
totalPagesInformation displayed in terms of pages