List of Virtual Accounts

You can use this endpoint to retrieve a list of all your Virtual Accounts or to retrieve a single Virtual Account by providing the virtualAccountNumberparameter. The endpoint returns all the Virtual Account information and the customer details, if any are available.

It is possible to filter the list of Virtual Accounts with the virtualAccountNumber parameter. When the parameter is used it will return Virtual Accounts with customer details in the chosen status.
The valid options for the parameter

  • Pending (customer details were added and they are in processing)
  • Processed (customer details exist)
  • Failed (customer details were added but processing failed)
  • Unallocated (no customer details exist)

The regionalEntities array is shown in the response when a Virtual Account exists in multiple regional entities. It contains the objects companyNumber, companyName, defaultAccount, status and relavant accountRepresentations for each regional entity, for example Lichtenstein (LI) as shown in the response example.

For more information on the individual objects, please have a look at the Responses section below. Expanding the 200 Success will list all possible objects and arrays.

Query Params
string

Virtual account number
Condition: Nullable string

string
length between 9 and 9

Company number of the company owning the accounts

int32
1 to 2147483647
Defaults to 1

Number of pages returned
Condition: Valid page number(1 to n)

int32
1 to 2000
Defaults to 10

No. of items returned per page
Condition: Valid page size(1 to 100)

string
enum

Filter to get virtual accounts by customer details status

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json