Skip to main content
PATCH
/
virtual-account
/
{virtualAccountId}
cURL
curl --request PATCH \
  --url https://api.slash.com/virtual-account/{virtualAccountId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "commissionDetails": {
    "amount": {
      "amountCents": 123
    },
    "startDate": "2023-11-07T05:31:56Z"
  }
}
'
{
  "virtualAccount": {
    "id": "<string>",
    "name": "<string>",
    "accountId": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "closedAt": "<string>"
  },
  "commissionRule": {
    "id": "<string>",
    "virtualAccountId": "<string>",
    "commissionDetails": {
      "amount": {
        "amountCents": 123
      },
      "startDate": "2023-11-07T05:31:56Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.slash.com/llms.txt

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

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Path Parameters

virtualAccountId
string
required

Body

application/json
action
enum<string>
required

The type of action to take. An action of type "update" will update the virtual account with the specified properties.

Available options:
update
name
string

The name to update the virtual account with.

commissionDetails
VirtualAccountCommissionDetails · object

Response

OK

virtualAccount
VirtualAccountModel · object
required

The virtual account object

commissionRule
VirtualAccountCommissionRule · object

The virtual account commission rule object