Overview

The Enable/Disable Sweep Schedule API allows ERP-integrated clients to activate or deactivate sweep schedules linked to virtual accounts. This functionality is crucial for managing account automation through temporarily disabling sweeps during maintenance or re-enabling them for resumed operations.

❗️
Important Information

Enable/Disable sweep schedule services can be applied only to accounts that have an existing active/inactive sweep schedule.

Enable/Disable 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_7612",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "active": true
        }               
      ]
    }
  ]
}
}'

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_7612",
      "sweepDetails": [
        {
          "fromacERPcode": "VA1234567890",
          "toacERPcode": "1234567890",
          "active": false
        }               
      ]
    }
  ]
}
}'

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
active	Mandatory	Status of the sweep to be mentioned as: `true` to enable the sweep schedule `false` to disable the sweep schedule	Boolean

Sample response

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

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

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