Note - Payee confirmation in the UKWhen 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.
Query parameters
The unique identifier of the banking alias.
Responses
200 - FR
200 - FR
Max. length: 255 charactersThe 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.The IBAN (international bank account number) of the banking alias.
The BIC (international identifier of the bank) for the banking alias.
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
Note: Once the banking alias is created, it is not possible to change the
CreditedUserId
.Returned values: DE, DK, ES, FR, GB, LU, PLThe country of the banking alias. The country must correspond to the currency of the wallet.
Max. length: 255 charactersCustom data that you can add to this object.
The date and time at which the object was created.
Whether or not the banking alias is active.Caution: Setting this value to
false
is irreversible.Returned values:
IBAN
, GB
The type of banking alias.The GB
value is only returned if the Country
is GB
.Max length: 128 characters (see data formats for details)The unique identifier of the object.
The unique identifier of the wallet.
200 - GB
200 - GB
Max. length: 255 charactersThe 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.The IBAN (international bank account number) of the banking alias.
The BIC (international identifier of the bank) for the banking alias.
The banking alias details in local format returned if applicable for the
Country
(e.g. GB
), otherwise null
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
Note: Once the banking alias is created, it is not possible to change the
CreditedUserId
.Returned values: DE, DK, ES, FR, GB, LU, PLThe country of the banking alias. The country must correspond to the currency of the wallet.
Max. length: 255 charactersCustom data that you can add to this object.
The date and time at which the object was created.
Whether or not the banking alias is active.Caution: Setting this value to
false
is irreversible.Returned values:
IBAN
, GB
The type of banking alias.The GB
value is only returned if the Country
is GB
.Max length: 128 characters (see data formats for details)The unique identifier of the object.
The unique identifier of the wallet.