Overview

The Sweep Configuration API service enables ERP-integrated clients to configure automated fund sweep schedules between virtual accounts and primary accounts. It supports multiple scheduling modes such as one-time, daily, weekly, monthly, yearly, and threshold balance-based sweeps for efficient liquidity management.

Configure a Virtual Account Sweep

Endpoint details

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

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVASweepService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVASweepServiceRQ": {
  "company": [
    {
      "companyCode": "1101",
      "userName": "sayeed_1234",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "schedule_type": "O",
          "schedule_date": "15/10"
        }
      ]
    }
  ]
}
}'

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVASweepService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVASweepServiceRQ": {
  "company": [
    {
      "companyCode": "1101",
      "userName": "sayeed_1234",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "schedule_type": "D",
          "schedule_hour": "15"
        }
      ]
    }
  ]
}
}'

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVASweepService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVASweepServiceRQ": {
  "company": [
    {
      "companyCode": "1101",
      "userName": "sayeed_1234",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "schedule_type": "W",
          "schedule_days": ["0","1","2","3","4","5","6"]
        }
      ]
    }
  ]
}
}'

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVASweepService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVASweepServiceRQ": {
  "company": [
    {
      "companyCode": "1101",
      "userName": "sayeed_1234",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "schedule_type": "M",
          "schedule_day": "26"
        }
      ]
    }
  ]
}
}'

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVASweepService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVASweepServiceRQ": {
  "company": [
    {
      "companyCode": "1101",
      "userName": "sayeed_1234",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "schedule_type": "Y",
          "schedule_date": "15/10"
        }
      ]
    }
  ]
}
}'

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVASweepService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVASweepServiceRQ": {
  "company": [
    {
      "companyCode": "1101",
      "userName": "sayeed_1234",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "schedule_type": "T",
          "threshold_amount": 1000
        }
      ]
    }
  ]
}
}'

Request description

JSON Tag	Requirement	Description	Data Type
svVASweepServiceRQ	Mandatory	Tag carrying information on request to configure a virtual account sweep	Object
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
sweepDetails	Mandatory	Tag carrying information on sweep details of the virtual account	Object
fromacERPcode	Mandatory	Unique account ERP identification code of the source account (Virtual account) from which the account is to be transferred Min: 9 Characters	Alphanumeric
toacERPcode	Mandatory	Unique account ERP identification code of the primary account to which the amount should be transferred Min: 9 Characters	Alphanumeric
schedule_type	Mandatory	Type of sweep schedule to be configured among: `O` - One-time `D` - Daily `W` - Weekly `M` - Monthly `Y` - Yearly `T` - For balance threshold	Alphabet
schedule_date	Conditional if `schedule_type` = `O` or `Y`	Date of the sweep schedule to be mentioned as `DD/MM` (Date/Month) format	String
schedule_hour	Conditional if `schedule_type` = `D`	Hour of the sweep schedule to be mentioned as `HH` (24 Hour) format	String
schedule_days	Conditional if `schedule_type` = `W`	Days of the sweep schedule to be mentioned as a list `["0","1","2","3","4","5","6"]` format where: 0 = Sunday 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday	String
schedule_day	Conditional if `schedule_type` = `M`	Sweep scheduled date to be mentioned as `DD` (Date) format	String
threshold_amount	Conditional if `schedule_type` = `T`	Amount at which the sweep is to be scheduled	Integer

Sample response

{
  "svVASweepServiceRS": {
    "company": [
      {
        "companyCode": "1101",
        "userName": "sayeed_1234",
        "sweepDetails": [
          {
            "fromacERPcode": "VA1234567890",
            "toacERPcode": "1234567890",
            "status": 0,
            "message": "Sweep configuration saved successfully"
          }
        ]
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svVASweepServiceRS	Tag carrying information on process response of Virtual Account services	Object
company	Tag carrying information on company	Object
companyCode	Unique company identification code	Numeric
userName	Unique username	String
sweepDetails	Tag carrying information on the requested virtual account sweeps	Object
fromacERPcode	Unique account ERP identification code of the source account (Virtual account) from which the account is to be transferred	Alphanumeric
toacERPcode	Unique account ERP identification code of the primary account to which the amount should be transferred	Alphanumeric
status	Status of the process	Numeric
message	Details on the process as per the status code	String