View Virtual Account availabilities

See your platform’s account capabilities per account type and country

GET /v2.01/{ClientId}/virtual-accounts/availability

REST

// GET has no body parameters

200

{
    "Collection": [
        {
            "Country": "GB",
            "Available": true,
            "Currencies": [
                "GBP"
            ]
        },
        {
            "Country": "LU",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "FR",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "ES",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "DE",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "US",
            "Available": true,
            "Currencies": [
                "USD"
            ]
        },
        {
            "Country": "CA",
            "Available": true,
            "Currencies": [
                "CAD"
            ]
        },
        {
            "Country": "DK",
            "Available": true,
            "Currencies": [
                "DKK"
            ]
        },
        {
            "Country": "PL",
            "Available": false,
            "Currencies": [
                "PLN"
            ]
        },
        {
            "Country": "AU",
            "Available": false,
            "Currencies": [
                "AUD"
            ]
        }
    ],
    "UserOwned": [
        {
            "Country": "GB",
            "Available": true,
            "Currencies": [
                "GBP"
            ]
        },
        {
            "Country": "LU",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "FR",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "ES",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "DE",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "US",
            "Available": true,
            "Currencies": [
                "USD"
            ]
        },
        {
            "Country": "CA",
            "Available": true,
            "Currencies": [
                "CAD"
            ]
        },
        {
            "Country": "DK",
            "Available": true,
            "Currencies": [
                "DKK"
            ]
        },
        {
            "Country": "PL",
            "Available": false,
            "Currencies": [
                "PLN"
            ]
        },
        {
            "Country": "AU",
            "Available": false,
            "Currencies": [
                "AUD"
            ]
        }
    ]
}

This endpoint allows you to check which account countries and currencies are available to your platform for Collection and User-Owned accounts (see guide for details).

Responses

200

Collection · array (object)

List of account capabilities for the account purpose and their availability for the platform.

Show child attributes

Country · string

Returned values: One of the supported countries in two-letter ISO 3166-1 format

The country of the account purpose.

Available · boolean

Whether or not the account is available for the given country and purpose.

Currencies · array

Returned values: One or more currency codes in ISO 4217 format (EUR, GBP, etc.)

List of currencies supported by the account.

UserOwned · array (object)

List of account capabilities for the account purpose and their availability for the platform.

Show child attributes

Country · string

Returned values: One of the supported countries in two-letter ISO 3166-1 format

The country of the account purpose.

Available · boolean

Whether or not the account is available for the given country and purpose.

Currencies · array

Returned values: One or more currency codes in ISO 4217 format (EUR, GBP, etc.)

List of currencies supported by the account.

REST

// GET has no body parameters

200

{
    "Collection": [
        {
            "Country": "GB",
            "Available": true,
            "Currencies": [
                "GBP"
            ]
        },
        {
            "Country": "LU",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "FR",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "ES",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "DE",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "US",
            "Available": true,
            "Currencies": [
                "USD"
            ]
        },
        {
            "Country": "CA",
            "Available": true,
            "Currencies": [
                "CAD"
            ]
        },
        {
            "Country": "DK",
            "Available": true,
            "Currencies": [
                "DKK"
            ]
        },
        {
            "Country": "PL",
            "Available": false,
            "Currencies": [
                "PLN"
            ]
        },
        {
            "Country": "AU",
            "Available": false,
            "Currencies": [
                "AUD"
            ]
        }
    ],
    "UserOwned": [
        {
            "Country": "GB",
            "Available": true,
            "Currencies": [
                "GBP"
            ]
        },
        {
            "Country": "LU",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "FR",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "ES",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "DE",
            "Available": true,
            "Currencies": [
                "EUR"
            ]
        },
        {
            "Country": "US",
            "Available": true,
            "Currencies": [
                "USD"
            ]
        },
        {
            "Country": "CA",
            "Available": true,
            "Currencies": [
                "CAD"
            ]
        },
        {
            "Country": "DK",
            "Available": true,
            "Currencies": [
                "DKK"
            ]
        },
        {
            "Country": "PL",
            "Available": false,
            "Currencies": [
                "PLN"
            ]
        },
        {
            "Country": "AU",
            "Available": false,
            "Currencies": [
                "AUD"
            ]
        }
    ]
}