Skip to main content
GET
/
virtual-account
/
{virtualAccountId}
cURL
curl --request GET \
  --url https://api.slash.com/virtual-account/{virtualAccountId} \
  --header 'X-API-Key: <api-key>'
{
  "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"
    }
  }
}

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

OK

​
virtualAccount
VirtualAccountModel · object
required

The virtual account itself

​
balance
Money · object
required

The total balance of the virtual account

​
spend
Money · object
required

The total spend of the virtual account

​
commissionRule
VirtualAccountCommissionRule · object

The commission rule applied to the virtual account, if any