bankingAliases

View a Banking Alias

Changed on
<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 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. </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>

View a Banking Alias

get/v2.01/{ClientId}/bankingaliases/{BankingAliasId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/bankingaliases/{BankingAliasId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

BankingAliasIdstring required

The unique identifier of the banking alias.

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.

VirtualAccountPurposestring

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 contract amendment.

For more information, see the virtual account guide.

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, 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}".

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.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id view_banking_alias removed and replaced with bankingAliases_view_banking_alias