Skip to main content
PUT
/
v2.01
/
{ClientId}
/
bankingaliases
/
{BankingAliasId}
{
    "Active": false,
}
  

{
    "OwnerName": "John Doe.",
    "IBAN": "FR617452110000GJX2HRBQPLS41",
    "BIC": "MPAYFRP1PIN",
    "CreditedUserId": "145397183",
    "Country": "FR",
    "Tag": "ibanized",
    "CreationDate": 1670342493,
    "Active": false,
    "Type": "IBAN",
    "Id": "157688274",
    "WalletId": "157688124"
}
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 – Deactivating a Banking Alias is irreversibleOnce the Banking Alias object is deactivated, you cannot reactivate it or attach another to the same wallet.Any funds wired to the banking alias won’t be credited to the corresponding wallet.If such cases arise, contact Mangopay via the Dashboard.

​
Path parameters

​
BankingAliasId
string
required
The unique identifier of the banking alias.

​
Body parameters

​
Active
boolean
required
Whether or not the banking alias is active.Caution: Setting this value to false is irreversible.

​
Responses

​
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.
​
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
Returned 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: IBAN, GBThe type of banking alias.The GB value is only returned if the Country is GB.
​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
WalletId
string
The unique identifier of the wallet.
{
    "OwnerName": "John Doe.",
    "IBAN": "FR617452110000GJX2HRBQPLS41",
    "BIC": "MPAYFRP1PIN",
    "CreditedUserId": "145397183",
    "Country": "FR",
    "Tag": "ibanized",
    "CreationDate": 1670342493,
    "Active": false,
    "Type": "IBAN",
    "Id": "157688274",
    "WalletId": "157688124"
}  

{
    "Active": false,
}