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.Caution – Rely on
OwnerName
returned in responseSince September 15, 2025, Mangopay sets the OwnerName
value by default based on the criteria available here.Your platform must rely on the API response value (also available on the GET endpoints) and ensure it is easy to see and copy for the end user in your interfaces.Note - Payee confirmation in the UKWhen 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
The unique identifier of the wallet.
Body parameters
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.Allowed values: DE, DK, ES, FR, GB, LU, PLThe country of the banking alias. The country must correspond to the currency of the wallet.
Max. length: 255 charactersCustom data that you can add to this object.
Responses
200 - FR
200 - FR
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.The IBAN (international bank account number) of the banking alias.
The BIC (international identifier of the bank) for the banking alias.
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
Note: Once the banking alias is created, it is not possible to change the
CreditedUserId
.Returned values: DE, DK, ES, FR, GB, LU, PLThe country of the banking alias. The country must correspond to the currency of the wallet.
Max. length: 255 charactersCustom 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
, GB
The type of banking alias.The GB
value is only returned if the Country
is GB
.Max length: 128 characters (see data formats for details)The unique identifier of the object.
The unique identifier of the wallet.
200 - GB
200 - GB
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.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 returned if applicable for the
Country
(e.g. GB
), otherwise null
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
Note: Once the banking alias is created, it is not possible to change the
CreditedUserId
.Returned values: DE, DK, ES, FR, GB, LU, PLThe country of the banking alias. The country must correspond to the currency of the wallet.
Max. length: 255 charactersCustom 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
, GB
The type of banking alias.The GB
value is only returned if the Country
is GB
.Max length: 128 characters (see data formats for details)The unique identifier of the object.
The unique identifier of the wallet.
400 - Country not supported
400 - Country not supported
400 - Wallet already has a Banking Alias
400 - Wallet already has a Banking Alias
400 - Invalid country for wallet currency
400 - Invalid country for wallet currency
403 - Feature not activated
403 - Feature not activated