View a Banking Alias for a Wallet

Path parameters

WalletId · string · required

The unique identifier of the wallet.

Responses

200

Array (Banking Alias) · array

The list of banking aliases created by the platform.

Show properties

Object (Banking Alias) · object

The Banking Alias object created by the platform.

Show properties

OwnerName · string

Max. length: 255 characters

The owner of the banking alias. The OwnerName must match the name of the user owning the wallet (FirstName and LastName for a Natural User, Name for a Legal User).

If Mangopay has provided your platform with a Technical Collection Virtual IBAN for reconciliation purposes, the OwnerName must be “Mangopay S.A.” or “Mangopay S.A. - Your Trading Name”. Please ensure your have confirmed this integration with our teams via the Dashboard.

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

Show child attributes

SortCode · string

The sort code of the banking alias in local format.

AccountNumber · string

The account number of the banking alias in local format.

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, PL

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

Tag · string

Max. length: 255 characters

Custom 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, GB

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

200 - FR

[
    {
        "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"
    }
]

NodeJS

const mangopayInstance = require('mangopay2-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let myWallet = {
  Id: '169738660',
}

const getWalletBankingAlias = async (walletId) => {
  return await mangopay.BankingAliases.getAll(walletId)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

getWalletBankingAlias(myWallet.Id)