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
Get Balance
Endpoint details
| Endpoint URL | Method | Authentication requirements |
|---|---|---|
/v1/api/osvPlatform/balanceEnquiry | POST | 1. clientId 2. clientCode 3. signature 4. sid 5. Authorization: Bearer |
Sample request
A Balance enquiry request in the following format should be posted to the above-mentioned URL.
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 Tag | Description | Data type |
|---|---|---|
| clientId Mandatory | Client ID | String |
| clientCode Mandatory | Client Code | String |
| signature Mandatory | Signature | String |
| sid Mandatory | Session ID | String |
| Authorization: Bearer Mandatory | Authorization Bearer Code i.e., Access Token | String |
| osvPlatformBalanceEnquiryRQ Mandatory | Balance Enquiry Request Tag | Object |
| userName Mandatory | Account Username | String |
| osvPlatformBanks Mandatory | Array of Banks | Array |
| bankCode Mandatory | Bank Code as per Bank Name | String |
| companyCode Mandatory | Company Code | String |
| b2bIdentifier Optional | B2B Identifier details with respect to Bank | String |
| b2bUserId Optional | B2B User ID details with respect to Bank | String |
| b2bUrn Optional | B2B URN details with respect to Bank | String |
| b2bAggrId Optional | B2B Aggregate ID details with respect to Bank | String |
| accountNumbers Mandatory | Array of Account Numbers | Array |
| Account_Number_1 Account_Number_2 Account_Number_3 Mandatory | List of Bank Account Numbers | String |
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 Tag | Description | Data type |
|---|---|---|
| osvPlatformBalanceEnquiryRS | Balance Enquiry Response Tag | Object |
| status | Status of the process | String |
| osvPlatformBanks | Array of Banks | Array |
| statusCode | Process Status Code | String |
| statusDetail | Process Status Details | String |
| bankCode | Bank Code | String |
| companyCode | Company Code | String |
| bankAvailableBalance | Available Bank Balances - Cumulative | Numerical |
| bankOpeningBalance | Opening Bank Balances - Cumulative | Numerical |
| bankClosingBalance | Closing Bank Balances - Cumulative | Numerical |
| bankAccounts | Array of Bank Accounts | Array |
| accountHolderName | Name of the Account Holder | String |
| accountNo | Bank Account Number | String |
| accountCurrency | Currency in which the Amount is Displayed | String |
| accountStatus | Status of the Bank Account | String |
| availableBalance | Available Balance in the Bank Account | Numerical |
| openingBalance | Opening Balance of the Bank Account | Numerical |
| closingBalance | Closing Balance of the Bank Account | Numerical |
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 Tag | Description | Data type |
|---|---|---|
| status | Status of the Process | String |
| errorCode | Error Code | String |
| message | Response Message | String |
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 Tag | Description | Data type |
|---|---|---|
| status | Status of the Process | String |
| errorCode | Error Code | String |
| message | Response Message | String |
Updated 7 months ago