Skip to main content
POST
/
account
/
virtual
/
sweep
Sweep Collection
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/account/virtual/sweep \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '
{
  "poolAccountNumber": "<string>",
  "amount": 123
}
'
{
	"statusCode": 00,
	"message": "Completed successfully"
	"data": {
		"amount": 1231241241
		"transactionId": "1214241241"
	},
	"errors": []
}

Documentation Index

Fetch the complete documentation index at: https://doc.withedge.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Sweep Collection

Use this endpoint to transfer funds from a designated pool account into a corporate account associated with your profile.

​
Request Parameters

​
requestId
string
required
A unique identifier for the request, used for idempotency.
Example: e0b9f8d0-7a57-4a67-a8b2-4d7c7b5a37c9
​
poolAccountNumber
string
required
The account number of the pool account from which funds will be swept.
Example: 5118745523
​
amount
double
required
The amount to be swept from the pool account.
Example: 100000.00
{
	"statusCode": 00,
	"message": "Completed successfully"
	"data": {
		"amount": 1231241241
		"transactionId": "1214241241"
	},
	"errors": []
}