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.
Note – Regulated feature
The virtual IBAN feature is regulated and has the following constraints:
- Activation is required, including in Sandbox (contact our teams via the Hub)
- A contract amendment is needed to specify the BIC to use for your platform
- Only one banking alias can be created per wallet
- Fees cannot be taken on pay-ins to banking aliases
Attributes
Max. length: 255 characters
The 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 Hub.
The IBAN (international bank account number) of the banking alias.
The BIC (international identifier of the bank) for the banking alias.
The banking alias details in local format. This parameter is only returned for applicable countries (for example, GB).
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
.
Allowed values: DE, DK, ES, FR, GB, LU, PL
The country of the banking alias. The country must correspond to the currency of the wallet.
Max. length: 255 characters
Custom data that you can add to this object.
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.
Related resources
Was this page helpful?