SLslashfi

List virtual accounts

Changed on

List accessible balance-bearing virtual accounts for the selected legal entity across all of its Accounts. Use accountId to select one Account. Virtual accounts in eligible bank Accounts can be used as fromAccount or toAccount; Global USD virtual accounts are read-only on API v2 transfer endpoints.

get/v2/virtual-accounts

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/virtual-accounts
  • Auth
    API key in header X-API-Key

Query parameters

cursorstring

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limitinteger

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

sort'createdAt'

Field to order the page by. createdAt is descending unless sortDirection is passed. See Sorting.

sortDirection'asc' | 'desc'

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

accountIdstring

Return virtual accounts in one accessible Account.

includeClosedboolean

Include closed virtual accounts. Defaults to false.

Response

A page of virtual accounts.

Example response

{
  "items": [
    {
      "commission": {
        "amount": {
          "amount": 1250
        }
      }
    }
  ]
}

Changes