Banking pay-insVirtual accountsBanking alias

Create an IBAN Banking Alias

Deprecated
<Warning icon="fa-regular fa-triangle-exclamation"> **Deprecated – Decommissioning planned for 2027** Mangopay plans to decommission the Banking Alias endpoints in 2027. Platforms using them should plan to re-integrate using the [Virtual Account](/api-reference/virtual-accounts/virtual-account-object) endpoints. Existing Banking Alias objects are available via the [GET View a Virtual Account](/api-reference/virtual-accounts/view-virtual-account) endpoint by using the Banking Alias `Id` and `WalletId` as path parameters. </Warning> <Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Rely on `OwnerName` returned in response** Since September 15, 2025, Mangopay sets the `OwnerName` value by default based on the criteria [available here](/guides/vop/payins#banking-alias-categorization). 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. </Warning> <Note icon="fa-regular fa-circle-info"> **Note - Payee confirmation in the UK** When 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. </Note> Create an IBAN Banking Alias

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
WalletIdstringRequired
The unique identifier of the wallet.

Request

This endpoint expects an object.
OwnerNamestringRequired

The 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.

CountrystringRequired

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.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success
OwnerNamestring

The 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.

IBANstring

The IBAN (international bank account number) of the banking alias.

BICstring

The BIC (international identifier of the bank) for the banking alias.

CreditedUserIdstring

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.

Countrystring

Returned values: DE, DK, ES, FR, GB, LU, PL

The country of the banking alias. The country must correspond to the currency of the wallet.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

Activeboolean

Whether or not the banking alias is active.

Caution: Setting this value to false is irreversible.

Typestring

Returned values: IBAN, GB

The type of banking alias.

The GB value is only returned if the Country is GB.

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

WalletIdstring
The unique identifier of the wallet.
LocalAccountDetailsobject

The banking alias details in local format returned if applicable for the Country (e.g. GB), otherwise null

Errors

400
Bad Request Error
403
Forbidden Error