The Banking Alias object
This use of this feature is subject to a declaration to the local banking authorities. We therefore require you to sign an amendment to your contract that will specify which BIC you will be able to use inconjuction with the IBAN. Please contact your account manager for more info
Banking aliases allow you to create a way to pay funds directly into a wallet, without having to declare the payin beforehand (unlike a traditional payin bankwire). For example, if you create an IBAN banking alias for a wallet, you'll be given a unique IBAN and BIC for this wallet. Any funds that we receive for this IBAN and BIC will be automatically credited to the wallet. You should be aware that you are unable to add Fees
to a payin created via a banking alias.
Note that only IBAN type banking aliases are available at present, and only the currency EUR is supported. You are also only able to create one banking alias per wallet due to regulation requirements. Once created, you can not change the CreditedUserId
These are the base parameters for a Banking Alias - for each type (see below) there are various other parameters specific to that type.
If required, you may request the address associated to the banking alias from our support team.
Please note that this functionality doesn't work with the old SDK versions, and with system prior to PHP 5.4.
Parameters
CreditedUserId
string:
Maximum length is 255 characters
The user ID who is credited (defaults to the owner of the wallet)
WalletId
string:
Maximum length is 255 characters
The ID of a wallet
Type
BankingAliasType:
IBAN
The type of banking alias. Currently only IBAN is supported
The type of banking alias (note that only IBAN is available at present)
Country
BankingAliasCountry:
LU, FR
The country format for the banking alias.
The country format for the banking alias.
OwnerName
string:
Maximum length is 255 characters
The owner of the wallet/banking alias
Active
bool:
true, false
Whether the banking alias is active or not