Skip to main content
POST
/
v2.01
/
{ClientId}
/
wallets
/
{WalletId}
/
bankingaliases
/
iban
{
    "OwnerName": "Alex Smith",
    "Country": "FR",
    "Tag": "Created using Mangopay API Postman Collection"
}  

{
    "OwnerName": "Alex Smith",
    "IBAN": "FR7674521100005657670994474",
    "BIC": "MPAYFRP1PIN",
    "CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
    "Country": "FR",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1710846581,
    "Active": true,
    "Type": "IBAN",
    "Id": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
    "WalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96"
}
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

​
WalletId
string
required
The unique identifier of the wallet.

​
Body parameters

​
OwnerName
string
required
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.
​
Country
string
required
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.

​
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
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.
​
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
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.
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "fd020620-8e5c-4b64-925c-aa980e42c237#1670340996",
    "Date": 1670340997.0,
    "errors": {
        "Country": "The requested country is not supported"
    }
}

{
    "Message": "There is already a banking alias existing for this wallet",
    "Type": "wallet_banking_alias_already_exists",
    "Id": "77b73aa3-e08e-4e04-9ffd-5c94ed4f73ff",
    "Date": 1732178114,
    "errors": null
}

{
    "Message": "Invalid country GB for EUR wallet. Possible value(s): LU/FR/ES/DE.",
    "Type": "country_not_associated_to_wallet_currency",
    "Id": "1eb1c947-bac2-4127-a636-fe7d811db9e7",
    "Date": 1725288513.0,
    "errors": null
}

{
    "Message": "This endpoint is not available for your account",
    "Type": "forbidden_ressource",
    "Id": "441d156a-ebd1-421e-851b-460a25c6a53f#1670262779",
    "Date": 1670262780.0,
    "errors": null
}  

{
    "OwnerName": "Alex Smith",
    "IBAN": "FR7674521100005657670994474",
    "BIC": "MPAYFRP1PIN",
    "CreditedUserId": "user_m_01HSB23417BFG7YXR7E371JSEA",
    "Country": "FR",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1710846581,
    "Active": true,
    "Type": "IBAN",
    "Id": "wltbank_m_01HSB6E769Y3ZBYDJACSP3THGA",
    "WalletId": "wlt_m_01HSB6DE1YT1EMTH0K7ASYPG96"
}

{
    "OwnerName": "Alex Smith",
    "Country": "FR",
    "Tag": "Created using Mangopay API Postman Collection"
}