Add Virtual Account
Link an additional virtual account for streamlined collections and tracking
Overview
The Add Virtual Account API is used to attach an additional virtual account under an already available setup. This is ideal when you need multiple virtual accounts for different purposes but want them all linked to the same settlement structure.
Key Features
- Expand Existing Setup – Add new virtual accounts without modifying the existing framework
- Multiple Accounts – Maintain separate virtual accounts for different transaction flows, business units, or reconciliation needs
- Real-Time Provisioning – Instantly add accounts and start using them for collections
Use Cases
- Assigning separate virtual accounts for invoices, projects, or departments
- Creating multiple collection points that settle into a single primary account
- Scaling transaction management by grouping payments under different virtual accounts
Add a Virtual Account
Endpoint details
Endpoint URL | Method | Authentication requirements |
---|---|---|
| POST |
|
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": "add",
"virAccount": [
{
"acERPcode": "1000000050",
"va_acERPcode": "va1234",
"alias": "GOLDEN GLORYS FOR ADVERTISING",
"customerRef": "11000044",
"capLimit": "100000",
"virtualAccountNumber": "34567894567",
"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 |
virtualAccountNumber Mandatory | Bank account number of the virtual account to be added to the ERP system | Alphanumeric |
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 of the virtual account | String |
Updated 13 days ago