> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mangopay.com/api-reference/banking-aliases/banking-alias-object/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server. # 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 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. > **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). #### 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 ### Schema (`ViewABankingAliasResponse`) ```yaml components: schemas: Tag: type: string description: >- Max. length: 255 characters Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: `"{\"id_1\":AB123,\"id_2\":DE456}"`. title: Tag CreationDate: type: integer description: Unix timestamp (UTC) of the date and time the object was created. title: CreationDate Id: type: string description: >- Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. title: Id SortCodeAccountNumber: type: object properties: SortCode: type: string description: The sort code of the banking alias in local format. AccountNumber: type: string description: The account number of the banking alias in local format. description: >- The banking alias details in local format returned if applicable for the `Country` (e.g. `GB`), otherwise `null` title: SortCodeAccountNumber ViewABankingAliasResponse: type: object properties: OwnerName: type: string description: >- 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. IBAN: type: string description: The IBAN (international bank account number) of the banking alias. BIC: type: string description: >- The BIC (international identifier of the bank) for the banking alias. VirtualAccountPurpose: type: string description: >- **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. CreditedUserId: type: string description: >- 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: type: string description: >- **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. Tag: $ref: '#/components/schemas/Tag' CreationDate: $ref: '#/components/schemas/CreationDate' Active: type: boolean description: |- Whether or not the banking alias is active. **Caution:** Setting this value to `false` is irreversible. Type: type: string description: |- **Returned values:** `IBAN`, `GB` The type of banking alias. The `GB` value is only returned if the `Country` is `GB`. Id: $ref: '#/components/schemas/Id' WalletId: type: string description: The unique identifier of the wallet. LocalAccountDetails: $ref: '#/components/schemas/SortCodeAccountNumber' title: ViewABankingAliasResponse ``` ### Related resources #### [Guide](/guides/payment-methods/banking/virtual-iban) Learn more about virtual IBAN #### [How to](/guides/payment-methods/banking/virtual-iban#collect-payments) Learn how to attach a virtual IBAN to a wallet