Balance

Get information on account balance

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 URLMethodAuthentication requirements
/v1/api/observice/balanceByIdPOST1. 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",
    "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