Batch delete virtual accounts

Deletes multiple virtual accounts by providing their account numbers.

Process Flow:

For each account number in the request:

Finds user credentials by account number

Retrieves user email from the user record

Calls SageCloud API to delete the virtual account

Returns detailed results for each deletion attempt

Response Structure:

totalCount: Total number of accounts in the request

successCount: Number of successfully deleted accounts

failureCount: Number of failed deletions

results: Array of detailed results for each account

Error Handling:

If a user or account is not found, that specific deletion fails but others continue

If SageCloud API returns an error for an account, that deletion fails but others continue

All errors are captured in the response with descriptive messages

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Delete single accountDelete multiple accountsLarge batch deletion

Example with one account number

{
    "accountNumbers": [
        "9876543210"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Batch deletion completed (may contain partial failures)

Body

Examples

All deletions successfulPartial failuresAll deletions failed

{
    "timestamp": "2025-01-15T10:30:00",
    "status": 200,
    "success": true,
    "message": "Batch deletion completed: 3 successful, 0 failed",
    "data": {
        "totalCount": 3,
        "successCount": 3,
        "failureCount": 0,
        "results": [
            {
                "accountNumber": "9876543210",
                "success": true,
                "message": "Account deleted successfully"
            },
            {
                "accountNumber": "1122334455",
                "success": true,
                "message": "Account deleted successfully"
            },
            {
                "accountNumber": "5566778899",
                "success": true,
                "message": "Account deleted successfully"
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized