Update a virtual account

Changed on

Rename an accessible virtual account or replace its commission. Omitted fields are left as they are. The primary virtual account of an Account and closed virtual accounts cannot be updated.

patch/v2/virtual-accounts/{virtualAccountId}

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/virtual-accounts/{virtualAccountId}
  • Auth
    API key in header X-API-Key

Path parameters

virtualAccountIdstring required

Virtual account id with the subaccount_ prefix.

Request body

namestring

New display name for the virtual account.

Example request

{
  "name": "Payroll (2026)",
  "commission": {
    "amount": {
      "amount": 1250
    }
  }
}

Response

The updated virtual account.

idstring required

Virtual account id with the subaccount_ prefix.

namestring required
accountIdstring required

Parent Account id with the sa_group_ prefix.

accountType'primary' | 'default' required
status'open' | 'closed' required

Example response

{
  "commission": {
    "amount": {
      "amount": 1250
    }
  }
}

Changes