The Banking Alias object
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 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 – Verification of Payee
Verification 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
Feeson 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,
LocalAccountDetailsare only available for the UK (CountryisGB), and no further country expansion is planned
Attributes
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.
The IBAN (international bank account number) of the banking alias.
The BIC (international identifier of the bank) for the banking alias.
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.
The banking alias details in local format returned if applicable for the Country (e.g. GB), otherwise null.
Untitled
The sort code of the banking alias in local format.
Length: 8 digits
The unique set of digits of the bank account.
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.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country in which the beneficial owner was born.
Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.
The date and time at which the object was created.
Whether or not the banking alias is active.
Caution: Setting this value to false is irreversible.
Returned values: IBAN
The type of banking alias.
The unique identifier of the object.
The unique identifier of the wallet that is to be taken into account.