​
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.
Caution – Replaced by Virtual AccountsNew integrations should use Virtual Accounts, which have replaced Banking Aliases. Existing banking aliases can continue to be used and these endpoints are still supported.
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. The OwnerName must match the name of the user owning the wallet (FirstName and LastName for a Natural User, Name for a Legal User).If Mangopay has provided your platform with a Technical Collection Virtual IBAN for reconciliation purposes, the OwnerName must be “Mangopay S.A.” or “Mangopay S.A. - Your Trading Name”. Please ensure your have confirmed this integration with our teams via the Dashboard.
​
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.
​
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