View Virtual Account availabilities

GET

/v2.01/:ClientId/virtual-accounts/availability

GET

/v2.01/:ClientId/virtual-accounts/availability

curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/virtual-accounts/availability \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "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"
      ]
    }
  ]
}

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

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).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Response

Success

Collectionlist of objectsOptional

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

UserOwnedlist of objectsOptional

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