> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

<Warning>
  **Deprecated – Decommissioning planned Q3 2026**

  Mangopay plans to decommission the Banking Alias endpoints in Q3 2026.

  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>

<Note>
  **Note – Verification of Payee**

  Verification of Payee (VOP) changes the behavior of the `OwnerName` value by setting it automatically based on the User's `UserCategory` and `KYCLevel`.

  Read more in the [VOP guide](/guides/vop).
</Note>

#### Constraints and comparison with virtual accounts:

* It's not possible to take `Fees` on External Instruction pay-ins to banking aliases – this constraint also exists on virtual accounts
* Only one Banking Alias can be created per wallet, whereas multiple are possible with virtual accounts (of the same [type](/guides/payment-methods/banking/virtual-iban#types))
* On Banking Alias, `LocalAccountDetails` are only available for the UK (`Country` is `GB`), and no further [country expansion](/guides/payment-methods/banking/virtual-iban#iban-countries-and-currencies) is planned

### Attributes

<ParamField body="OwnerName" type="string">
  Max. length: 255 characters

  The owner of the banking alias, which is set automatically by Mangopay since September 15, 2025 ([read more](/guides/vop/payins#banking-alias-categorization)).

  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](/api-reference/users/natural-user-object-sca) or the `Name` value for a [Legal User](/api-reference/users/legal-user-object-sca). 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.
</ParamField>

<ParamField body="IBAN" type="string">
  The IBAN (international bank account number) of the banking alias.
</ParamField>

<ParamField body="BIC" type="string">
  The BIC (international identifier of the bank) for the banking alias.
</ParamField>

<ResponseField name="VirtualAccountPurpose" type="string">
  **Returned values:** `COLLECTION`, `USER_OWNED`

  The type of the virtual account:

  * `COLLECTION` - Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.
  * `USER_OWNED` - Owned by the wallet owner, enabling them to accept and store funds and make payments. Offering User-Owned Accounts requires your platform to sign the [VOP](/guides/vop) contract amendment.

  For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide.
</ResponseField>

<ParamField body="LocalAccountDetails" type="object">
  The banking alias details in local format returned if applicable for the `Country` (e.g. `GB`), otherwise `null`.

  <Expandable>
    <ParamField body="SortCode" type="string">
      The sort code of the banking alias in local format.
    </ParamField>

    <ParamField body="AccountNumber" type="string">
      The account number of the banking alias in local format.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="CreditedUserId" type="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`.
</ParamField>

<ParamField body="Country" type="string">
  **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.
</ParamField>

<ParamField body="Tag" type="string">
  Max. length: 255 characters

  Custom data that you can add to this object.
</ParamField>

<ParamField body="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ParamField>

<ParamField body="Active" type="boolean">
  Whether or not the banking alias is active.\
  Caution: Setting this value to `false` is irreversible.
</ParamField>

<ParamField body="Type" type="string">
  **Returned values:** `IBAN`

  The type of banking alias.
</ParamField>

<ParamField body="Id" type="string">
  The unique identifier of the object.
</ParamField>

<ParamField body="WalletId" type="string">
  The unique identifier of the wallet.
</ParamField>

### Related resources

<CardGroup col={2}>
  <Card title="Guide" href="/guides/payment-methods/banking/virtual-iban">Learn more about virtual IBAN</Card>

  <Card title="How to" href="/guides/payment-methods/banking/virtual-iban#collect-payments">Learn how to attach a virtual IBAN to a wallet</Card>
</CardGroup>