Overview

The Create Virtual Account API allows you to generate a brand-new virtual account with its own unique configuration. This API is typically used when you need a fresh account setup for collections or reconciliation.

Key Features

Independent Account Creation – Provision new virtual accounts with unique identifiers
Configurable Setup – Define parameters such as settlement account, validity period, and account labels
Instant Activation – New virtual accounts are ready for use immediately after creation

Use Cases

Issuing a dedicated virtual account for a new transaction stream
Setting up virtual accounts for subscription billing or recurring payments
Generating temporary virtual accounts for limited-time events or campaigns.

Create a Virtual Account

Endpoint details

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

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVAService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVAServiceRQ": {
  "groupCode": "1000",
  "company": [
    {
      "companyCode": "1101",
      "userName": "muhammad_1278",
      "type": "create",
      "virAccount": [
        {
          "acERPcode": "1000000050",
          "va_acERPcode": "VA10000000501",
          "alias": "GOLDEN GLORYS FOR ADVERTISING",
          "customerRef": "11000044",
          "capLimit": "100000",
          "clientId": "34535345",
          "schemId": "12345",
          "merchantId": "3453555"
        }
      ]
    }
  ]
}
}'

Request description

JSON Tag	Description	Data Type
svVAServiceRQ Mandatory	Tag carrying information on request to create virtual account	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	Numeric
userName Mandatory	Unique user identification name Length of input: Min 3 Characters Max 20 Characters	String
virAccount Mandatory	Tag carrying information on virtual account creation request	Object
acERPcode Mandatory	Unique account ERP identification code Length of input: Min 3 Characters Max 20 Characters	Numeric
va_acERPcode Mandatory	Unique account ERP identification code for virtual account	Alphanumeric
alias Mandatory	Alias information Length of input: Min 3 Characters Max 20 Characters	String
customerRef Mandatory	Unique customer reference details	Numeric
capLimit Mandatory	Maximum limit of the amount in virtual account	Numeric
clientId Conditional for SAB	Unique client identification provided by the bank	Numeric
schemId Conditional for Alinma & SNB	Unique identification number for the virtual account services provided by the Alinma and SNB banks	Numeric
merchantId Conditional for Alinma & SNB	Unique merchant identification details provided by the Alinma and SNB banks	Numeric

Sample response

{
  "svVAServiceRS": {
    "company": [
      {
        "companyCode": "1101",
        "userName": "muhammad_1278",
        "virAccount": {
          "acERPcode": "1000000050",
          "alias": "GOLDEN GLORYS FOR ADVERTISING",
          "customerRef": "11000044",
          "virtualIBAN": "SA7947100001430112345678",
          "va_acERPcode": "VA10000000501",
          "accountNumber": "79471000014301"
        }
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svVAServiceRS	Tag carrying information on process response of Virtual Account services	Object
company	Tag carrying information on company	Object
companyCode	Unique company identification code	Numerical
userName	Unique username	String
virAccount	Tag carrying information on virtual account	Object
acERPcode	Unique ERP account code	Numerical
alias	Unique alias details	String
customerRef	Unique customer reference number	Numerical
virtualIBAN	Unique virtual IBAN	String
va_acERPcode	Unique account ERP identification code for virtual account	String
accountNumber	Unique account number allocated to the newly created virtual account	String