The Banking Alias object (BETA*)

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.

Please note that this functionality doesn't work with the old SDK versions, and with system prior to PHP 5.4.

Parameters

CreditedUserId
string

string:

Maximum length is 255 characters

The user ID who is credited (defaults to the owner of the wallet)

WalletId
string

string:

Maximum length is 255 characters

The ID of a wallet

Country
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

Type
BankingAliasType

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)

OwnerName
string

string:

Maximum length is 255 characters

The owner of the wallet/banking alias

Active
bool

bool:

true, false

Whether the banking alias is active or not

*This feature is in BETA, please contact your account manager if you want more information.

{
"CreditedUserId": "8494514",
"WalletId": "8494559",
"Country": "FR",
"Type": "IBAN",
"OwnerName": "Joe Blogs",
"Active": true
}

The IBAN Bank Aliasing object

Parameters

CreditedUserId
string

string:

Maximum length is 255 characters

The user ID who is credited (defaults to the owner of the wallet)

WalletId
string

string:

Maximum length is 255 characters

The ID of a wallet

Type
BankingAliasType

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
CountryIso

CountryIso:

AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

A valid ISO 3166-1 alpha-2 format

The Country of the Address

OwnerName
string

string:

Maximum length is 255 characters

The owner of the wallet/banking alias

Active
bool

bool:

true, false

Whether the banking alias is active or not

IBAN
string

string:

Maximum length is 255 characters

The IBAN of the banking alias

BIC
string

string:

Maximum length is 255 characters

The BIC of the banking alias

{
"CreditedUserId": "8494514",
"WalletId": "8494559",
"Type": "IBAN",
"Country": "FR",
"OwnerName": "Joe Blogs",
"Active": true,
"IBAN": "FR927452175160VJHJ0LKR4AH17",
"BIC": "MPAYFRP1EMI"
}

Create an IBAN Banking Alias

POST .../v2.01/ClientId

The ID of your client account

/wallets/WalletId

The ID of a wallet

/bankingaliases/iban/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

CreditedUserId
string

string:

Maximum length is 255 characters

optional

The user ID who is credited (defaults to the owner of the wallet)

OwnerName
string

string:

Maximum length is 255 characters

required

The owner of the wallet/banking alias

Country
BankingAliasCountry

BankingAliasCountry:

LU, FR

The country format for the banking alias. Note that FR is not currently available, but will be shortly.

required

The country format for the banking alias. Note that FR is not currently available, but will be shortly.

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
POST .../wallets/:WalletId/bankingaliases/iban/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"CreditedUserId": "8494514",
"OwnerName": "Joe Blogs",
"Country": "FR"
}
POST .../wallets//bankingaliases/iban/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"CreditedUserId": "",
"OwnerName": "",
"Country": ""
}

Deactivate a Banking Alias

Note that once deactivated, a banking alias can't be reactivated afterwards, and any funds received to this banking alias will then be refused

PUT .../v2.01/ClientId

The ID of your client account

/bankingaliases/BankingAliasId

The ID of a banking alias

/

Parameters

Active
bool

bool:

true, false

required

Whether the banking alias is active or not

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
PUT .../bankingaliases/:BankingAliasId/ HTTP/1.1
Body Parameters :
{
"Active": true
}
PUT .../bankingaliases// HTTP/1.1
Body Parameters :
{
"Active": ""
}

View a Banking Alias

View the details of a banking alias

GET .../v2.01/ClientId

The ID of your client account

/bankingaliases/BankingAliasId

The ID of a banking alias

/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../bankingaliases/:BankingAliasId/ HTTP/1.1
GET .../bankingaliases// HTTP/1.1

View the Banking Alias for a Wallet

To view a wallet's banking aliases - remember that you can only have one banking alias per wallet (even though it is a list format).

GET .../v2.01/ClientId

The ID of your client account

/wallets/WalletId

The ID of a wallet

/bankingaliases/

Get parameters

Page
int

int

optional

The page number of results you wish to return

Per_Page
int

int

optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

The column to sort against and direction, separated by a :

optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

BeforeDate
timestamp

timestamp

optional

To return only resources that have CreationDate BEFORE this date

AfterDate
timestamp

timestamp

optional

To return only resources that have CreationDate AFTER this date

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../wallets/:WalletId/bankingaliases/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC",
"BeforeDate": 1463440221,
"AfterDate": 1431817821
}
GET .../wallets//bankingaliases/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": "",
"BeforeDate": ,
"AfterDate":
}
Live chat
No agent is free at the moment please send us a request through our contact form