Virtual Accounts

Generate virtual account to collect payments

Overview

Virtual accounts are digital sub-accounts linked to a primary account, allowing businesses to manage funds more efficiently. They can be used for customer payments, reconciliation, and automated financial operations. SingleView API enables users to create and manage virtual accounts seamlessly within their ERP systems.

Create a Virtual Account

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/erp/svVAServicePOST1. clientid
2. clientsecret
3. 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 TagDescriptionData Type
clientid
Mandatory
Unique client identification details
Length of input:
Min 3 Characters
Max 20 Characters
String
clientsecret
Mandatory
Unique client secret code
Length of input:
Min 3 Characters
Max 20 Characters
String
signature
Mandatory
64-Bit string obtained by processing client signature key through Base-64 and SHA-256String
svVAServiceRQ
Mandatory
Tag carrying information on request to create virtual accountObject
groupCode
Mandatory
Unique group identification code
Length of input:
Min 3 Characters
Max 20 Characters
Numeric
company
Mandatory
Tag carrying information about companyObject
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 requestObject
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 accountAlphanumeric
alias
Mandatory
Alias information
Length of input:
Min 3 Characters
Max 20 Characters
String
customerRef
Mandatory
Unique customer reference detailsNumeric
capLimit
Mandatory
Maximum limit of the amount in virtual accountNumeric
clientId
Conditional for SAB
Unique client identification provided by the bankNumeric
schemId
Conditional for Alinma & SNB
Unique identification number for the virtual account services provided by the Alinma and SNB banksNumeric
merchantId
Conditional for Alinma & SNB
Unique merchant identification details provided by the Alinma and SNB banksNumeric

Sample response

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

Response description

JSON TagDescriptionData Type
svVAServiceRSTag carrying information on process response of Virtual Account servicesObject
companyTag carrying information on companyObject
companyCodeUnique company identification codeNumerical
userNameUnique usernameString
virAccountTag carrying information on virtual accountObject
acERPcodeUnique ERP account codeNumerical
aliasUnique alias detailsString
customerRefUnique customer reference numberNumerical
virtualIBANUnique virtual IBANString
va_acERPcodeUnique account ERP identification code for virtual accountString
accountNumberUnique account number allocated to the newly created virtual accountString

Add a Virtual Account

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/erp/svVAServicePOST1. clientid
2. clientsecret
3. 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": "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 TagDescriptionData Type
clientid
Mandatory
Unique client identification details
Length of input:
Min 3 Characters
Max 20 Characters
String
clientsecret
Mandatory
Unique client secret code
Length of input:
Min 3 Characters
Max 20 Characters
String
signature
Mandatory
64-Bit string obtained by processing client signature key through Base-64 and SHA-256String
svVAServiceRQ
Mandatory
Tag carrying information on request to create virtual accountObject
groupCode
Mandatory
Unique group identification code
Length of input:
Min 3 Characters
Max 20 Characters
Numeric
company
Mandatory
Tag carrying information about companyObject
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 requestObject
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 accountAlphanumeric
alias
Mandatory
Alias information
Length of input:
Min 3 Characters
Max 20 Characters
String
customerRef
Mandatory
Unique customer reference detailsNumeric
capLimit
Mandatory
Maximum limit of the amount in virtual accountNumeric
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 bankNumeric
schemId
Conditional for Alinma & SNB
Unique identification number for the virtual account services provided by the Alinma and SNB banksNumeric
merchantId
Conditional for Alinma & SNB
Unique merchant identification details provided by the Alinma and SNB banksNumeric

Sample response

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

Response description

JSON TagDescriptionData Type
svVAServiceRSTag carrying information on process response of Virtual Account servicesObject
companyTag carrying information on companyObject
companyCodeUnique company identification codeNumerical
userNameUnique usernameString
virAccountTag carrying information on virtual accountObject
acERPcodeUnique ERP account codeNumerical
aliasUnique alias detailsString
customerRefUnique customer reference numberNumerical
virtualIBANUnique virtual IBANString
va_acERPcodeUnique account ERP identification code for virtual accountString
accountNumberUnique account number of the virtual accountString