Overview

The Virtual Account Details API allows authorized users to retrieve virtual account information mapped to one or more companies under a specific group. The response provides bank-wise virtual account details, including account identifiers, status, limits, currency, and IBAN information.

📘
Important Info

This service can be used to fetch all virtual account through the companyCode identifier that generates a list of all the active and inactive banks associated with the company

The optional acERPcode value can be passed with the primary account ERP identification code to fetch a list of active and inactive virtual accounts associated with a specific primary account

Fetch Virtual Account(s) Info

Endpoint details

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

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svGetVAService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svGetVAServiceRQ": {
  "groupCode": "1000",
  "company": [
    {
      "companyCode": "1234",
      "userName": "muhammad_1234",
      "acERPcode":"1234567899055"
    }
  ]
}
}'

Request description

JSON Tag	Description	Data Type
svGetVAServiceRQ Mandatory	Tag carrying information on request to fetch information about virtual accounts	Object
groupCode Mandatory	Unique group identification code Length of input: Min 3 Characters Max 20 Characters	Numeric
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
acERPcode Conditional	Unique primary account ERP identification code Mandatory to fetch virtual accounts linked to a specific primary account Min: 9 Characters	Numeric

Sample responses

Fetch Virtual Account(s) Info Successful Response

{
  "svGetVAServiceRS": {
    "company": [
      {
        "companyCode": "1234",
        "userName": "muhammad_1234",
        "banks": [
          {
            "bankCode": "NCB",
            "virtualAccounts": [
              {
                "va_acERPcode": "NCB1234567850",
                "accountHolderName": "COMPANYCOL123",
                "currency": "SAR",
                "country": "SA",
                "isActive": true,
                "aliasName": "Collection123",
                "primaryAccountNumber": "05143212696512",
                "primaryIBANAccountNumber": "SA8975051005143212696512",
                "capLimit": "20000",
                "customerRef": "876542",
                "vaIBANAccountNumber": "SA8473000078901234567900",
                "vaAccountNumber": "78901234567900"
              }
            ]
          },
          {
            "bankCode": "ALRAJHI",
            "virtualAccounts": [
              {
                "va_acERPcode": "ALRAJHIVA01",
                "accountHolderName": "COMPANYCOL456",
                "currency": "SAR",
                "country": "SA",
                "isActive": true,
                "aliasName": "Collection456",
                "primaryAccountNumber": "204608012129232",
                "primaryIBANAccountNumber": "SA8123963204608012129232",
                "capLimit": "50000",
                "customerRef": "876541",
                "vaIBANAccountNumber": "SA8473000078901234567901",
                "vaAccountNumber": "78901234567901",
                "perDayLimit": "1000",
                "perMonthLimit": "50000"
              }
            ]
          }
        ]
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svGetVAServiceRS	Tag carrying information on process response of fetch Virtual Account(s) info services	Object
company	Tag carrying information on company	Object
companyCode	Unique company identification code	Numerical
userName	Unique username	String
banks	Tag carrying information about bank-wise collection of virtual accounts	Array
bankCode	Unique bank identification code	String
VirtualAccounts	List of virtual accounts belonging to a specific bank	Array
va_acERPcode	Unique virtual account ERP code	Alphanumeric
accountHolderName	Name of the account holder	String
currency	Code representing the default currency of the virtual account	Alphabet
country	Code representing the country of the virtual account	Alphabet
isActive	Active status of the virtual account represented as `true` for active and `false` for inactive	Boolean
aliasName	Alias information about the virtual account	String
primaryAccountNumber	Primary account number associated with the virtual account	Numeric
primaryIBANAccountNumber	Primary IBAN associated with the virtual account	Alphanumeric
capLimit	Maximum limit of the amount assigned to the virtual account	Numeric
customerRef	Unique customer reference identification details	Numeric
vaIBANAccountNumber	Virtual account IBAN standardized details	Alphanumeric
vaAccountNumber	Unique virtual account number	Alphanumeric
perDayLimit	Daily threshold limit assigned to the account	Numeric
perMonthLimit	Monthly threshold limit assigned to the account	Numeric

Fetch Virtual Account(s) Info Failed Response

{
  "svGetVAServiceRS": {
    "company": [
      {
        "companyCode": "1234",
        "userName": "muhammad_1234",
        "status": 1,
        "errorCode": "ER04020",
        "message": "No virtual accounts found"
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svGetVAServiceRS	Tag carrying information on process response of fetch Virtual Account(s) info services	Object
company	Tag carrying information on company	Object
companyCode	Unique company identification code	Numerical
userName	Unique username	String
status	Code representing the status of the process	Numeric
errorCode	Code representing the error encountered during the request processing	String
message	Details on the error encountered during the processing of the request	String