GET
/
virtual-account
cURL
curl --request GET \
  --url https://api.joinslash.com/virtual-account \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "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"
        }
      }
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Authentication from public API requests

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.

Response

200
application/json

OK

The response is of type object.