Skip to main content

​
Description

Mangopay relies on the Banking Alias object to create a virtual IBAN or account number attached to a wallet. Once attached, the IBAN can be used by end users to wire funds directly to the wallet.
Deprecated – Decommissioning planned Q3 2026Mangopay plans to decommission the Banking Alias endpoints in Q3 2026.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 – Verification of PayeeVerification of Payee (VOP) changes the behavior of the OwnerName value by setting it automatically based on the User’s UserCategory and KYCLevel.Read more in the VOP guide.

​
Constraints and comparison with virtual accounts:

  • It’s not possible to take Fees on External Instruction pay-ins to banking aliases – this constraint also exists on virtual accounts
  • Only one Banking Alias can be created per wallet, whereas multiple are possible with virtual accounts (of the same type)
  • On Banking Alias, LocalAccountDetails are only available for the UK (Country is GB), and no further country expansion is planned

​
Attributes

​
OwnerName
string
Max. length: 255 charactersThe 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_OWNEDThe 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.
For more information, see virtual account guide.
​
LocalAccountDetails
object
The banking alias details in local format returned if applicable for the Country (e.g. GB), otherwise null.
​
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
Allowed values: DE, DK, ES, FR, GB, LU, PLThe country of the banking alias. The country must correspond to the currency of the wallet.
​
Tag
string
Max. length: 255 charactersCustom 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: IBANThe type of banking alias.
​
Id
string
The unique identifier of the object.
​
WalletId
string
The unique identifier of the wallet.

Guide

Learn more about virtual IBAN

How to

Learn how to attach a virtual IBAN to a wallet
⌘I