Skip to main content
GET
/
virtual-account
cURL
curl --request GET \
  --url https://api.slash.com/virtual-account \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "virtualAccount": {
        "id": "<string>",
        "name": "<string>",
        "accountId": "<string>",
        "accountNumber": "<string>",
        "routingNumber": "<string>",
        "closedAt": "<string>"
      },
      "balance": {
        "amountCents": 123
      },
      "spend": {
        "amountCents": 123
      },
      "commissionRule": {
        "id": "<string>",
        "virtualAccountId": "<string>",
        "commissionDetails": {
          "amount": {
            "amountCents": 123
          },
          "startDate": "2023-11-07T05:31:56Z"
        }
      }
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

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.

Query Parameters

cursor
string

A cursor string to fetch the next page of results

filter:accountId
string

Pass in an account ID to filter virtual accounts by account ID. This will return all virtual accounts that match the account ID passed in.

filter:includeClosedAccounts
enum<string>

Include virtual accounts that have been closed in the query results. By default, they will not be returned.

Available options:
true,
false

Response

OK

items
VirtualAccount · object[]
required
metadata
PaginationResponse · object

Response sent when requesting a list of data