Overview

svVABalanceEnqService provides a way for ERP systems and backend services to query the current available balance and related metadata for a virtual account. This endpoint returns account-level balance details for one or more virtual accounts tied to a company user.

❗️
Important Information

This service is restricted to fetch the balances exclusively for virtual accounts.

Fetch Virtual Account Balance

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/erp/svVABalanceEnqService`	POST	`clientid` `clientsecret` `signature`

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVABalanceEnqService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svBalanceEnqServiceRQ": {
  "groupCode": "1234",
  "company": [
    {
      "companyCode": "1122",
      "userName": "MOHAMMED_1234",
      "account": [
        {
          "va_acERPcode": "ALRAJHIVA001"
        }
      ]
    }
  ]
}
}'

Request description

JSON Tag	Requirement	Description	Data Type
svVABalanceEnqService	Mandatory	Tag carrying information on request to fetch virtual account balance	Object
groupCode	Conditional	Unique group identification code Length of input: Min 3 Characters Max 20 Characters	String
company	Mandatory	Tag carrying information about company	Object
companyCode	Mandatory	Unique company identification code Length of input: Min 3 Characters Max 20 Characters	String
userName	Mandatory	Unique user identification name Length of input: Min 3 Characters Max 20 Characters	String
account	Mandatory	Tag carrying information on virtual account details to fetch the balance	Object
va_acERPcode	Mandatory	Unique account ERP identification code of the virtual account Min: 9 Characters	Alphanumeric

Sample response

{
  "svBalanceEnqServiceRS": {
    "company": [
      {
        "companyCode": "1122",
        "userName": "MOHAMMED_1234",
        "account": [
          {
            "va_acERPcode": "ALRAJHIVA001",
            "Balance": {
              "SequenceNum": "",
              "ReceiptTime": "",
              "AccountNumber": "SA3280900000665991239013",
              "AccountCurrency": "SAR",
              "AccountStatus": "",
              "AccountStatusDesc": "",
              "CustomerFullName": "",
              "AccountType": "",
              "AuthorizedOdLimit": "",
              "LastCreditDate": "",
              "LastCreditAmount": "",
              "AvailableBalance": 1000,
              "AvailableBalanceLCY": "",
              "OpeningBalanceLCY": "",
              "OpeningBalance": "",
              "ClosingBalance": "",
              "DebitAllowed": "",
              "CreditAllowed": "",
              "StatusCode": "OK",
              "StatusDetail": "OK"
            }
          }
        ]
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svBalanceEnqServiceRS	Tag carrying information on process response of Virtual Account balance services	Object
company	Tag carrying information on company	Object
companyCode	Echoes back the companyCode from the request	String
userName	Echoes back the userName from the request	String
account	Tag carrying information on one or more account entries included in the request	Object
va_acERPcode	Echoes the va_acERPcode from the request	Alphanumeric
Balance	Tag carrying information as balance metadata for the virtual account	Object
SequenceNum	Internal sequence or trace number (if available)	Alphanumeric
ReceiptTime	Timestamp of the balance snapshot in ISO 8601 standard format	Date
AccountNumber	Bank account number that is mapped to the provided virtual account code in the request	String
AccountCurrency	Unique code denoting the currency of the virtual account	String
AccountStatus	Short status code for the account as `Active` pr `Inactive`	String
AccountStatusDesc	Status description for the mentioned account	String
CustomerFullName	Full name of the customer holding the account	String
AccountType	Type of account	String
AuthorizedOdLimit	Amount representing the over-draft limit for the account	Numeric
LastCreditDate	Date & time of the last credit to the account	Date
LastCreditAmount	Amount of the last credit transaction	Numeric
AvailableBalance	Available balance in the virtual account	Numeric
AvailableBalanceLCY	Available balance in local currency (for accounts supporting multicurrency)	Numeric
OpeningBalanceLCY	Opening balance in local currency (for accounts supporting multicurrency)	Numeric
OpeningBalance	Opening balance of the account for the `ReceiptTime`	Numeric
ClosingBalance	Closing balance of the account for the `ReceiptTime`	Numeric
DebitAllowed	Flag indicating whether debits are permitted for the virtual account	String
CreditAllowed	Flag indicating whether credits are permitted for the virtual account	String
StatusCode	Code representing the status of the process	String
StatusDetail	Details on the `StatusCode`	String