Update virtual account

Authorizations

X-API-Key

string

header

required

Authentication from public API requests

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

commissionDetails

object

commissionDetails.amount

object

required

The amount of money to be diverted from the virtual account if the type of rule is flat_fee.

commissionDetails.amount.amountCents

integer

required

The amount in cents

commissionDetails.frequency

enum<string>

required

The frequency from the start date that the rule will be applied. E.g. a start date of November 26, 2024 with a frequency of "monthly" will have the rule applied on December 26, 2024. If the frequency was "yearly", the rule would be applied again on November 26, 2025.

Available options:

monthly,

yearly

commissionDetails.type

enum<string>

required

The type of the commission rule. A type of flat_fee will take a flat fee from the virtual account and transfer it to the primary account with the frequency of the collection defined as monthly or yearly.

Available options:

flatFee

commissionDetails.startDate

string

The date that the rule will begin to take effect.

name

string

The name to update the virtual account with.

Response

200 - application/json

virtualAccount

object

required

The virtual account object

virtualAccount.accountId

string

required

The account ID of the Slash account the virtual account is associated with.

virtualAccount.accountType

enum<string>

required

The account type of the virtual account. Since virtual accounts and Slash accounts exist at the same hierarchy level, an account type of 'primary' means it is the main Slash account, while an account type of 'default' means it is a virtual account under the main account.

Available options:

default,

primary

virtualAccount.id

string

required

The ID of the virtual account.

virtualAccount.name

string

required

The name of the virtual account.

virtualAccount.accountNumber

string

The account number of the virtual account.

virtualAccount.closedAt

string

The date the virtual account was closed; will be null if account was never closed.

virtualAccount.routingNumber

string

The routing number of the virtual account.

commissionRule

object

The virtual account commission rule object

commissionRule.commissionDetails

object

required

Describes details of the commission rule.

commissionRule.commissionDetails.amount

object

required

The amount of money to be diverted from the virtual account if the type of rule is flat_fee.

commissionRule.commissionDetails.amount.amountCents

integer

required

The amount in cents

commissionRule.commissionDetails.frequency

enum<string>

required

Available options:

monthly,

yearly

commissionRule.commissionDetails.type

enum<string>

required

Available options:

flatFee

commissionRule.commissionDetails.startDate

string

The date that the rule will begin to take effect.

commissionRule.id

string

required

The ID of the commission rule

commissionRule.virtualAccountId

string

required

The ID of the virtual account the commission rule is applied to

Overview

Entities

Legal Entity

Account

Virtual Account

Transaction

Slash Pay

Card

Card Group

Merchant

Webhooks

Update virtual account

Authorizations

Path Parameters

Body

Response