List Virtual Accounts for a Wallet

GET

/v2.01/:ClientId/wallets/:WalletId/virtual-accounts

GET

/v2.01/:ClientId/wallets/:WalletId/virtual-accounts

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

200Retrieved

{
  "Array (Virtual Accounts)": [
    {
      "Object (Virtual Account)": {
        "AccountOwner": "string",
        "Active": true,
        "Capabilities": {
          "Currencies": [
            "string"
          ],
          "InternationalPayinAvailable": true,
          "LocalPayinAvailable": true
        },
        "Country": "string",
        "CreationDate": 1,
        "Id": "string",
        "InternationalAccountDetails": null,
        "LocalAccountDetails": {
          "Account": {
            "AccountNumber": "string",
            "BSBCode": "string"
          },
          "Address": {
            "Country": "string",
            "CountrySubDivision": "string",
            "PostCode": "string",
            "StreetName": "string",
            "TownName": "string"
          },
          "BankName": "string"
        },
        "ResultCode": "string",
        "ResultMessage": "string",
        "Status": "string",
        "Tag": "string",
        "VirtualAccountPurpose": "string",
        "WalletId": "string"
      }
    }
  ]
}

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.

WalletIdstringRequired

The unique identifier of the wallet.

Query parameters

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageintegerOptional

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

SortstringOptional

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

Indicates the direction in which to sort the list.

Response

Success

Array (Virtual Accounts)list of objectsOptional

The list of virtual accounts created by the platform.