Check the available balance of a virtual account in real-time
Retrieve the available balance of a virtual account in real time. Use this API to check the funds available in a virtual account using its Virtual IBAN.
Domain details
Environment
Domain
Rate/Limit
Sandbox
3 Calls per Minute
Production/LIVE
To be provided upon onboarding
Based on contract
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
curl --location 'https://sandboxapi.onesingleview.com/api/v2/virtualaccount/balance' \
--header 'SVReferenceID: SV123456' \
--header 'CompanyId: SINGLEVIEW1234' \
--header 'Device: web' \
--header 'DateTimeStamp: 2025-01-07T10:20:39' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNeVN4WFRCZjlqUlNWQzFad3B5QnlkOVpHelZXR2ZwUmFQNUUrY3d6cVQ5bi9OV0lwR2V5STNNMkdPL1pqakd4ZG0yclJkVEZxY3lhWGNpWnZFejl0V1EySjQxK2VvSlk2ZjdJZkFsV3BKRi9VL1YydDEzMUtnRnVhcnd6MzVQY1UzbnFEV0p0UWlzIiwiaWF0IjoxNzY3NzYxODc3LCJleHAiOjE3Njc3NjU0Nzd9.lWDSB3Rk_TtdUbKyFcCdaE5XGo7UDiTu2kDcqEyU7vg' \
--header 'Content-Type: application/json' \
--data '{
"Message": {
"SVVABalanceEnquiryReq": {
"TransactionType": "VABE",
"BankCode": "ALRAJHI",
"ReferenceNumber":"98765432146565",
"SchemeId": "CollectionOSV",
"VAClientId": "SV123456789",
"VirtualIBAN": "SA5680900000735991239014"
}
},
"Signature": "rZZ9alg/2k9B5uWSdnW3AfYswAMqA4HXyNX3jIzckWb4o37uS4eKFEQ3xRn/dBarN6EGjfaXiMSOPdKyyjjrgT80K5ReXzQ7cC1INuU79ozlLgK8yTFz+nq785geQ+He4PR+hD35DkF9qnela9qmcr3GhAXpTjZG12hmaJEyzeofh6q3p+jqLFd208eAImubnL6SbSBDEAi5SLRH1K2I1U77OmFNirrfGV8qd+gsi+lqgyF9mpNj6lzy/fJNNe0qEr2WHvG1R7E2g3EhqovDNanQt6RFgkWegtlE37Eyi5qO3xlTqu76317ZWfMI7jHxs48fOLTNtBCOwUboVze5Tw=="
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
Message | Mandatory | Header information (client credentials) | Object |
SVVABalanceEnquiryRequest | Mandatory | Root node containing all the info to check balance of a virtual account | Object |
TransactionType | Mandatory | Details on the type of transaction to be specified as | String |
BankCode | Mandatory | Unique bank identification code
| String |
ReferenceNumber | Mandatory | Unique reference number for the request generated by the client | String |
SchemeId | Mandatory | Identifier of the virtual account scheme provided by the partner bank to the client | String |
VAClientId | Mandatory | Unique client identifier for the virtual account provided by the partner bank to the client | String |
VirtualIBAN | Mandatory | IBAN of the virtual account to be provided for balance enquiry service | String |
Signature | Mandatory | Encrypted string generated using a Private Key/CA-Signed Certificate with SHA-256 and RSA (JCE Signature) | String |
{
"SVVABalanceEnquiryResp": {
"TransactionType": "VABE",
"BankCode": "ALRAJHI",
"ReferenceNumber": "98765432146565",
"StatusCode": "Completed",
"StatusDetail": "Balance fetched successfully.",
"VirtualAccountInfo": {
"VirtualIBAN": "SA5680900000735991239014",
"Currency": "SAR",
"AvailableBalance": "98464"
}
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
SVVABalanceEnquiryResp | Root node | Object |
TransactionType | Details on the type of transaction as specified in the request as | String |
BankCode | Unique bank identification code
| Object/Array |
ReferenceNumber | Unique reference number for the request generated and passed by the client in the request | String |
StatusCode | Code representing status of the transaction processing | String |
StatusDetail | Details of the status code represented for the transaction processing | String |
VirtualAccountInfo | Tag carrying information on the manage virtual account in the request | Object |
VirtualIBAN | IBAN of the virtual account representing the available balance | String |
Currency | Currency in which the balance is provided. | String |
AvailableBalance | Current available balance of the virtual account | String |
StatusCode | StatusDetail |
|---|---|
Completed | Balance fetched successfully. |
Failed | Bank response description |
Response_Timeout | Timeout! Unable to get response from the bank. Please try again or contact SingleView support if issue persists. |