Get virtual account

GET

virtual-account

{virtualAccountId}

cURL

curl --request GET \
  --url https://api.slash.com/virtual-account/{virtualAccountId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.slash.com/virtual-account/{virtualAccountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/virtual-account/{virtualAccountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "virtualAccount": {
    "id": "<string>",
    "name": "<string>",
    "accountId": "<string>",
    "accountType": "default",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "closedAt": "<string>"
  },
  "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"
    }
  }
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

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

Response

virtualAccount

VirtualAccountModel · object

required

The virtual account itself

Hide child attributes

virtualAccount.id

string

required

The ID of the virtual account.

virtualAccount.name

string

required

The name of the virtual account.

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.accountNumber

string

The account number of the virtual account.

virtualAccount.routingNumber

string

The routing number of the virtual account.

virtualAccount.closedAt

string

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

balance

Money · object

required

The total balance of the virtual account

Hide child attributes

balance.amountCents

integer

required

The amount in cents

spend

Money · object

required

The total spend of the virtual account

Hide child attributes

spend.amountCents

integer

required

The amount in cents

commissionRule

VirtualAccountCommissionRule · object

The commission rule applied to the virtual account, if any

Hide child attributes

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

commissionRule.commissionDetails

VirtualAccountCommissionDetails · object

required

Describes details of the commission rule.

VirtualAccountCommissionDetails
VirtualAccountCommissionDetails

Hide child attributes

commissionRule.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

commissionRule.commissionDetails.amount

Money · object

required

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

Hide child attributes

commissionRule.commissionDetails.amount.amountCents

integer

required

The amount in cents

commissionRule.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

commissionRule.commissionDetails.startDate

string<date-time>

The date that the rule will begin to take effect.

⌘I

cURL

curl --request GET \
  --url https://api.slash.com/virtual-account/{virtualAccountId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.slash.com/virtual-account/{virtualAccountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/virtual-account/{virtualAccountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "virtualAccount": {
    "id": "<string>",
    "name": "<string>",
    "accountId": "<string>",
    "accountType": "default",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "closedAt": "<string>"
  },
  "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"
    }
  }
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

Overview

Entities

Legal Entity

Account

Account Authorization Webhooks

Virtual Account

Transaction

Transfer Money

Card

Card Group

Invoice

Invoice Series

Expense Report

Customer

Contact

Merchant

Webhooks

Agent Requests

Tokens

Get virtual account

Authorizations

Path Parameters

Response