View a Banking Alias for a Wallet

GET /v2.01/{ClientId}/wallets/{WalletId}/bankingaliases

NodeJS

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let myWallet = {
  Id: '169738660',
}

const getWalletBankingAlias = async (walletId) => {
  return await mangopay.BankingAliases.getAll(walletId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

getWalletBankingAlias(myWallet.Id)  

200 - FR

[
    {
        "OwnerName": "MGP PlatformTradingName",
        "IBAN": "FR7674521100005657670994474",
        "BIC": "MPAYFRP1PIN",
        "VirtualAccountPurposeResponse": "COLLECTION",
        "CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
        "Country": "FR",
        "Tag": "Created using Mangopay API Postman Collection",
        "CreationDate": 1710846581,
        "Active": true,
        "Type": "IBAN",
        "Id": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
        "WalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96"
    }
]

Deprecated – Decommissioning planned for 2027

Mangopay plans to decommission the Banking Alias endpoints in 2027.

Platforms using them should plan to re-integrate using the Virtual Account endpoints.

Existing Banking Alias objects are available via the GET View a Virtual Account endpoint by using the Banking Alias Id and WalletId as path parameters.

Note - Payee confirmation in the UK

When the user sets up the payee with their bank, Mangopay UK or Mangopay SA is displayed as the account holder name. You should communicate this to them to avoid confusion.

Path parameters

WalletId · string · required

The unique identifier of the wallet.

Responses

200

Array (Banking Alias) · array

The list of banking aliases created by the platform.

Show properties

Object (Banking Alias) · object

The Banking Alias object created by the platform.

Show properties

OwnerName · string

Max. length: 255 characters

The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 (read more).

If the User owning the attached wallet has UserCategory of OWNER and the KYCLevel of REGULAR, then the OwnerName is set to the FirstName and LastName values for a Natural User or the Name value for a Legal User. In this case, the VirtualAccountPurpose in the API response is USER_OWNED.

If the User is not KYC verified and an OWNER, then the OwnerName is set to “MGP PlatformTradingName” in standard cases, or else “Mangopay” for Marketplace Payment Extension (MPE) workflows. In this case, the VirtualAccountPurpose in the API response is COLLECTION.

Caution: Your platform must ensure that you use the OwnerName returned in the API response.

IBAN · string

The IBAN (international bank account number) of the banking alias.

BIC · string

The BIC (international identifier of the bank) for the banking alias.

VirtualAccountPurpose · string

Returned values: COLLECTION, USER_OWNED

The type of the virtual account:

• COLLECTION - Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.
• USER_OWNED - Owned by the wallet owner, enabling them to accept and store funds and make payments. Offering User-Owned Accounts requires your platform to sign the VOP contract amendment.

For more information, see the virtual account guide.

LocalAccountDetails · object

The banking alias details in local format returned if applicable for the Country (e.g. GB), otherwise null

Show child attributes

SortCode · string

The sort code of the banking alias in local format.

AccountNumber · string

The account number of the banking alias in local format.

CreditedUserId · string

The unique identifier of the user whose wallet is credited, in other words, the Owner of the wallet for which the alias is created.
Note: Once the banking alias is created, it is not possible to change the CreditedUserId.

Country · string

Returned values: DE, DK, ES, FR, GB, LU, PL

The country of the banking alias. The country must correspond to the currency of the wallet.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.

CreationDate · Unix timestamp

The date and time at which the object was created.

Active · boolean

Whether or not the banking alias is active.

Caution: Setting this value to false is irreversible.

Type · string

Returned values: IBAN, GB

The type of banking alias.

The GB value is only returned if the Country is GB.

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

WalletId · string

The unique identifier of the wallet.

200 - FR

[
    {
        "OwnerName": "MGP PlatformTradingName",
        "IBAN": "FR7674521100005657670994474",
        "BIC": "MPAYFRP1PIN",
        "VirtualAccountPurposeResponse": "COLLECTION",
        "CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
        "Country": "FR",
        "Tag": "Created using Mangopay API Postman Collection",
        "CreationDate": 1710846581,
        "Active": true,
        "Type": "IBAN",
        "Id": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
        "WalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96"
    }
]

NodeJS

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let myWallet = {
  Id: '169738660',
}

const getWalletBankingAlias = async (walletId) => {
  return await mangopay.BankingAliases.getAll(walletId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

getWalletBankingAlias(myWallet.Id)