Retrieve the available balance of a bank account through the SingleView APIs
Balance Enquiry API enables businesses to retrieve the available balance of a bank account associated with their company. The API validates the request, forwards the balance enquiry to the specified bank, and returns the account balance along with the processing status.
BankCode, CompanyCode, and AccountNumber are valid and correctly formattedAvailableBalance is returned within BalanceEnquiryInfo for successful requestsErrorCode field is empty when the request is successfully completedResponse_Timeout as confirmation that the balance enquiry failed at the bank. The bank's final processing status may require a subsequent enquiry or retryERR are bank-provided errors, while MW-XXX errors are generated by SingleView's validation layerYYYY-MM-DDTHH:mm:ss🌐 Domain details
Environment
Domain
Rate/Limit
Sandbox
3 Calls per Day
Production/LIVE
To be provided upon onboarding
Based on contract
Endpoint details
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
curl --location 'https://sandboxapi.onesingleview.com/api/v2/balance' \
--header 'CompanyId: MYCOMPANY'
--header 'SVReferenceID: SV150619940615'
--header 'DateTimeStamp :2025-01-02T10:20:39'
--header 'Device: Web'
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNMlZ4WGpFZmR6WFNWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUV1TXl6S1Aybi94Y0lwR2V5STNNMkdPL1pqakd4ZG0yclJKUkdhRXlaWGNpWnZnOHArMWIyOGtOQTVkZ0VKajVVSEdiTmtNPSIsImlhdCI6MTczNTgwMTQ3NywiZXhwIjoxNzM1ODA1MDc3fQ.Bh7LFkvxNFrLe9dmH5rURWjGpES-u4z2EGeyrNM7z6E'
--header 'Content-Type: application/json' \
--data '{
"Message": {
"OSVBalanceEnquiryRequest": {
"TransactionType": "BE",
"BankCode": "RIYADH",
"CompanyCode": "COMPANY001",
"AccountNumber": "2011123456789"
}
},
"Signature": "FuJPkgDw2U0ZruL2TnIypUqqbdu9/KpGFX0tLns0rtvlOKR/2PKsJbgxWdIhJXvXwx8tG6b0JPr4M/afkGXkm6j5ua7VC3Z8L2k6amycZ9gCZU1uCyPYI8LRhod79jGOZIbQRY8CQj7uRqT/eKZWlwLf5qhKY7Tf0n6yBhaH51qfvlCzB6BW0Ol0riclN51VQOhKjqHQ25PRbFzu4BDUURm+z/4fJY9kKkWdDbwxoov1+AGDeu/sz0kG/lJK69ra1UXwkOtiAZk5VmnsfrkqCIVQqDsim/yAN5dVeI7Yw3ZTXGtOX4FKSp+0mCW+sfLoKhCaBwG/dbBMx6lkQqF+sg=="
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
Message | Mandatory | Header information (client credentials) | Object |
OSVBalanceEnquiryRequest | Mandatory | Tag carrying request information for balance enquiry | Object |
TransactionType | Mandatory | Transaction type specification to be provided as | String |
BankCode | Mandatory | Unique bank identification code
| String |
CompanyCode | Mandatory | Sender company code/Identifier provided by the bank during on-boarding | String |
AccountNumber | Mandatory | Valid bank account number Input size: | String |
Signature | Mandatory | Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature) | String |
{
"OSVBalanceEnquiryResponse": {
"BankCode": "RIYADH",
"CompanyCode": "COMPANY0",
"AccountNumber": "2011123456789",
"StatusCode": "Completed",
"ErrorCode": "",
"StatusDetail": "Account balance fetched successfully.",
"TimeStamp": "2025-02-28T07:35:25",
"BalanceEnquiryInfo": {
"AvailableBalance": "3405688934.32",
"AccountCurrency": "SAR"
}
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
OSVBalanceEnquiryResponse | Tag carrying information on balance enquiry response | Object |
BankCode | Unique bank identification code
| String |
CompanyCode | Sender company code/Identifier provided by the bank during on-boarding | String |
AccountNumber | Account number passed in the request for balance enquiry | String |
StatusCode | Code representing the status of the request processed | String |
ErrorCode | Value representing the Error code obtained only for failed scenarios | String |
StatusDetail | Details of the response | String |
TimeStamp | Date and time denoting the generation of response | String |
BalanceEnquiryInfo | Tag carrying information on account balance | Object |
AvailableBalance | Value representing the available balance in the account in their default currency | String |
AccountCurrency | Code denoting the currency in which the balance is displayed Value not provided by Bank Al Jazira | String |
For information on errors, visit Errors handling.