---
title: "Get settlement accounts"
method: GET
path: "/virtual-accounts"
tags: ["Settlement Accounts"]
---

# Get settlement accounts

`GET /virtual-accounts`

The `GET /virtual-accounts` endpoint retrieves information for all settlement accounts.

## Query parameters

- `limit` integer
- `offset` string
- `currency` string
- `country` string
- `nickname` string
- `onBehalfOfId` string

## Response `200`

Successful response

- GetVirtualAccountsResponse — Contains the response to the get settlement accounts request.
  - `pageInfo` PageInfo — The information about the current page, which also indicates whether the next page exists.
    - `limit` integer, required — The limit (maximum number of objects to return) applied to this page. <br/>The default and maximum allowed limit is 200. If this limit is exceeded, was not set or was set to 0, it will be set to 200.
    - `offset` string — The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset is provided in the request (<i>i.e.</i> this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to the dynamic nature of the data. <br/>The offset is opaque to a user and should not be parsed and/or understood in any way.
    - `nextOffset` string — The offset for the next page. If the page is empty, it is equal to this page offset. If the page is not empty, but there are no more objects to load (haveMore = false), it will be empty.<br/>The offset is opaque to a user and should not be parsed and/or understood in any way.
    - `haveMore` boolean — This field indicates whether there are more objects to load, <i>i.e.</i> whether the next page exists.
  - `virtualAccount` VirtualAccount[]
    - `accountId` string — The system-generated, unique id which specifies the settlement account.
    - `accountName` string — The name of this account.
    - `accountNickName` string — The alias name that identifies the settlement account.
    - `accountNumber` string — The unique identifier for the bank account in the UK or Ireland.
    - `availableBalance` string — The available account balance at the time of the query. For example, the previous day's closing balance +/- transactions during the day, and any overdraft facilities.
    - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long."
    - `bookedBalance` string — The account balance pending clearance, which may include uncleared items and any transactions yet to settle.
    - `clearedBalance` string — The cash balance in an account that can be immediately withdrawn or used in financial transactions. Until funds have cleared, they're considered to be pending and customers are unable to use them in transactions.
    - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
    - `createdDateTime` string, string — The date this account was created (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
    - `currency` string — The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
    - `iban` string — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    - `sortCode` string — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland.
    - `status` 'INVALID' | 'ACTIVE' | 'CLOSED' | 'BLOCKED' | 'CLIENT_BLOCKED'
    - `updatedDateTime` string, string — The date and time this account was last updated (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
    - `onBehalfOfId` string — The id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field will contain the sub-TPP `referenceId`. This field is mandatory for unregulated TPPs.

## Other responses

- `400` — The client specified an invalid argument
- `401` — The authorization information is missing or invalid
- `403` — Permission to access this endpoint is denied
- `404` — The requested entity, such as a TPP, was not found
- `429` — Too many requests
- `500` — An unexpected or internal server error
- `501` — The operation was not implemented
- `503` — Service is unavailable
- `504` — Gateway has timed out

---

[API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/revisions/5e8d6d2c24a1/schema)