Overview
Entities
Legal Entity
Virtual Account
Transaction
Card
Card Group
Get virtual account
Retrieve a single virtual account by its ID.
curl --request GET \
--url https://api.joinslash.com/virtual-account/{virtualAccountId} \
--header 'X-API-Key: <api-key>'{
"virtualAccount": {
"id": "<string>",
"name": "<string>",
"accountNumber": "<string>",
"routingNumber": "<string>",
"accountId": "<string>",
"closedAt": "<string>",
"accountType": "default"
},
"balance": {
"amountCents": 123
},
"spend": {
"amountCents": 123
},
"commissionRule": {
"id": "<string>",
"virtualAccountId": "<string>",
"commissionDetails": {
"type": "flatFee",
"amount": {
"amountCents": 123
},
"frequency": "monthly",
"startDate": "2023-11-07T05:31:56Z"
}
}
}Authorizations
Authentication from public API requests
Path Parameters
Response
The virtual account itself
The ID of the virtual account.
The name of the virtual account.
The account ID of the Slash account the virtual account is associated with.
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.
default, primary The account number of the virtual account.
The routing number of the virtual account.
The date the virtual account was closed; will be null if account was never closed.
The total balance of the virtual account
The amount in cents
The total spend of the virtual account
The amount in cents
The commission rule applied to the virtual account, if any
The ID of the commission rule
The ID of the virtual account the commission rule is applied to
Describes details of the commission rule.
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.
flatFee The amount of money to be diverted from the virtual account if the type of rule is flat_fee.
The amount in cents
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.
monthly, yearly The date that the rule will begin to take effect.
curl --request GET \
--url https://api.joinslash.com/virtual-account/{virtualAccountId} \
--header 'X-API-Key: <api-key>'{
"virtualAccount": {
"id": "<string>",
"name": "<string>",
"accountNumber": "<string>",
"routingNumber": "<string>",
"accountId": "<string>",
"closedAt": "<string>",
"accountType": "default"
},
"balance": {
"amountCents": 123
},
"spend": {
"amountCents": 123
},
"commissionRule": {
"id": "<string>",
"virtualAccountId": "<string>",
"commissionDetails": {
"type": "flatFee",
"amount": {
"amountCents": 123
},
"frequency": "monthly",
"startDate": "2023-11-07T05:31:56Z"
}
}
}