v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Virtual Accounts

List virtual accounts

List and filter virtual accounts.

get/virtual_accounts

Query parameters

limitinteger
starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the virtual account.

end_datestring date

The creation date of the virtual account.

namestring

The name of the virtual account.

virtual_account_numberstring

The virtual account number.

connected_account_idstring uuid

The ID of the connected account to which the virtual account refers.

counterparty_idstring uuid

The ID of the counterparty to which the virtual account refers to.

disabledboolean

If true, only disabled virtual accounts will be fetched.

Response

200

Example response

{
  "records": [
    {
      "metadata": {
        "property_a": true,
        "property_b": "some text"
      }
    }
  ]
}