Balance Enquiry

Retrieve single or multiple bank account balances

Overview

Balance Enquiry is a part of Data API and is accessed to request and retrieve specific user bank account balances. There is certain information that is required to pass a request for Balance enquiry:

📘

Mandatory information

  • The user must provide the valid credentials in the header
    • Valid Access code as "Authorization: Bearer" and Session ID
    • The request should be in the specified format
    • The request should include all the mandatory details with appropriate request tags

Sample request

A Balance enquiry request in the following format should be posted to the URL https://servicesuat.onesingleview.com/v1/api/osvPlatform/balanceEnquiry.

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/osvPlatform/balanceEnquiry' \
--header 'clientId: Enter_Client_ID' \
--header 'clientCode: Enter_Client_Code' \
--header 'signature: Enter_Signature' \
--header 'sid: Enter_Session_ID' \
--header 'Authorization: Bearer Enter_Access_Token' \
--header 'Content-Type: application/json' \
--header 'Cookie: _redisPractice=s%3Aiqp4yTRCjCsqTNphd2OuSP1zIysw7Kwu.4R%2BHVD8jJ07Q89cC4ZqxyO8I7InfA6KH9DF9TYqZ%2FsY' \
--data-raw '{
  "osvPlatformBalanceEnquiryRQ": {
    "userName":"User_name",
    "osvPlatformBanks": [
      {
        "bankCode": "Bank_Name",
        "companyCode": "Enter_Company_Code",
        "b2bIdentifier": "Enter_B2B_Identifier",
        "b2bUserId": "Enter_B2B_User_ID",
        "b2bUrn": "Enter_B2B_URN",
        "b2bAggrId": "Enter_B2B_Aggregate_ID",
        "accountNumbers": [
          Account_Number_1,
          Account_Number_2,
          Account_Number_3
        ]
      }
    ]
  }
}'

Request description:

JSON TagDescriptionData type
clientId
Mandatory
Client IDString
clientCode
Mandatory
Client CodeString
signature
Mandatory
SignatureString
sid
Mandatory
Session IDString
Authorization: Bearer
Mandatory
Authorization Bearer Code i.e., Access TokenString
osvPlatformBalanceEnquiryRQ
Mandatory
Balance Enquiry Request TagObject
userName
Mandatory
Account UsernameString
osvPlatformBanks
Mandatory
Array of BanksArray
bankCode
Mandatory
Bank Code as per Bank NameString
companyCode
Mandatory
Company CodeString
b2bIdentifier
Optional
B2B Identifier details with respect to BankString
b2bUserId
Optional
B2B User ID details with respect to BankString
b2bUrn
Optional
B2B URN details with respect to BankString
b2bAggrId
Optional
B2B Aggregate ID details with respect to BankString
accountNumbers
Mandatory
Array of Account NumbersArray
Account_Number_1
Account_Number_2
Account_Number_3
Mandatory
List of Bank Account NumbersString

Sample responses

Valid/Successful response

✔️ If Valid information in the header and body of a request is processed successfully

{
    "osvPlatformBalanceEnquiryRS": {
        "status": "SUCCESS",
        "osvPlatformBanks": [
             {
                "status": "SUCCESS",
                "statusCode": "200",
                "statusDetail": "Status_Message",
                "bankCode": "Bank_Code",
                "companyCode": "Company_Code",
                "bankAvailableBalance": 0000.00,
                "bankOpeningBalance": 0000.00,
                "bankClosingBalance": 0000.00,
                "bankAccounts": [
                    {
                        "accountHolderName": "Account_Holder_Name1",
                        "accountNo": "Account_Number_1",
                        "accountCurrency": "Currency_Displayed",
                        "accountStatus": "Status_of_Account",
                        "availableBalance": 0000.00,
                        "openingBalance": 0000.00,
                        "closingBalance": 0000.00
                    },
                    {
                        "accountHolderName": "Account_Holder_Name2",
                        "accountNo": "Account_Number_2",
                        "accountCurrency": "Currency_Displayed",
                        "accountStatus": "Status_of_Account",
                        "availableBalance": 0000.00,
                        "openingBalance": 0000.00,
                        "closingBalance": 0000.00
                    },
                    {
                        "accountHolderName": "Account_Holder_Name3",
                        "accountNo": "Account_Number_3",
                        "accountCurrency": "Currency_Displayed",
                        "accountStatus": "Status_of_Account",
                        "availableBalance": 0000.00,
                        "openingBalance": 0000.00,
                        "closingBalance": 0000.00
                    }
                ]
            }
        ]
    }
}

Valid/Successful response description:

JSON TagDescriptionData type
osvPlatformBalanceEnquiryRSBalance Enquiry Response TagObject
statusStatus of the processString
osvPlatformBanksArray of BanksArray
statusCodeProcess Status CodeString
statusDetailProcess Status DetailsString
bankCodeBank CodeString
companyCodeCompany CodeString
bankAvailableBalanceAvailable Bank Balances - CumulativeNumerical
bankOpeningBalanceOpening Bank Balances - CumulativeNumerical
bankClosingBalanceClosing Bank Balances - CumulativeNumerical
bankAccountsArray of Bank AccountsArray
accountHolderNameName of the Account HolderString
accountNoBank Account NumberString
accountCurrencyCurrency in which the Amount is DisplayedString
accountStatusStatus of the Bank AccountString
availableBalanceAvailable Balance in the Bank AccountNumerical
openingBalanceOpening Balance of the Bank AccountNumerical
closingBalanceClosing Balance of the Bank AccountNumerical

Invalid/Failed response

❌ If Invalid information in the header of a request is processed successfully

{
        status: "FAILURE",
        errorCode: "Failed_Code",
        message: "Failed_Message"
      }

Invalid/failed response description:

JSON TagDescriptionData type
statusStatus of the ProcessString
errorCodeError CodeString
messageResponse MessageString

Response in case of a Technical error is encountered

⚠️ When the process encounters a technical error

{
        status: "TECHERROR",
        errorCode: "Error_Code",
        message: "Error_Message"
      }

Error response description:

JSON TagDescriptionData type
statusStatus of the ProcessString
errorCodeError CodeString
messageResponse MessageString