RegisterIbanExtended: Add Bank Details to a Payment Account for Money-Outs

Version

Description

1.1

The IBAN ID is returned in the response. It is possible to add many IBANs per payment account.

1.0

New mandatory fields for non-IBAN information depending on countries and currencies (USD specificities)

How it works

To send money-outs to your clients, you need to register their bank details. With "RegisterIbanExtended" method, our system links other bank formats to a Payment Account.

  • Bank details are only needed for money-outs, not for money-ins or P2P.

  • Please use the other api method “moneyouts/iban” for all IBANs.

  • Depending on your business, the account information may be automatically active. If it is not, our control team needs to validate it with the uploaded bank document.

  • By default, you can only register one account number per payment account, when you link a new account number all previous ones linked to the same payment account will be automatically deactivated. If you wish to link several account numbers to one wallet please contact us for approval.

Depending on bank country code selected or when a USD environment is concerned, 5 fields may be required :

  • bankBranchCode (or sort code pour UK)

  • bankName

  • bankBranchAddressStreet

  • bankBranchAddressZipCode

  • bankCity

Please find attached below the list of country codes and associated mandatory fields.
1 = mandatory
0 = not mandatory

CountriesBankAccountDetailsRules.xlsx

Request


XML

<RegisterIBANExtended xmlns="Service_mb_xml">
      <wallet>string</wallet>
      <accountType>string</accountType>
      <holderName>string</holderName>
      <accountNumber>string</accountNumber>
      <holderCountry>string</holderCountry>
      <bicCode>string</bicCode>
      <bankName>string</bankName>
      <bankCountry>string</bankCountry>
      <bankBranchCode>string</bankBranchCode>
      <bankBranchAddressStreet>string</bankBranchAddressStreet>
      <bankBranchAddressZipCode>string</bankBranchAddressZipCode>
      <bankBranchAddressCity>string</bankBranchAddressCity>
      <intermediaryBicCode>string</intermediaryBicCode>
      <intermediaryBankName>string</intermediaryBankName>
      <intermediaryBankCountry>string</intermediaryBankCountry>
      <comment>string</comment>
      <wlLogin>string</wlLogin>
      <wlPass>string</wlPass>
      <language>string</language>
      <version>string</version>
      <walletIp>string</walletIp>
      <walletUa>string</walletUa>
   </RegisterIBANExtended>

JSON

{
    "wallet": "string",
    "accountType": "string",
    "holderName": "string",
    "accountNumber": "string",
    "holderCountry": "string",
    "bicCode": "string",
    "bankName": "string",
    "bankCountry": "string",
    "bankBranchCode": "string",
    "bankBranchAddressStreet": "string",
    "bankBranchAddressZipCode": "string",
    "bankBranchAddressCity": "string",
    "intermediaryBicCode": "string",
    "intermediaryBankName": "string",
    "intermediaryBankCountry": "string",
    "comment": "string",
    "wlLogin": "string",
    "wlPass": "string",
    "language": "string",
    "version": "string",
    "walletIp": "string",
    "walletUa": "string"
  }

Item

Description

Mandatory

Format

Example

wallet

Payment account ID

Yes

[0 : 256] char

33612345678 ou taxi67

accountType

Account type, by default Other.

IBAN = 1,
BBAN/RIB = 2,
Other = 0

No1 char0

holderName

The owner of the registered bank account : first name and last name, or company name.

Yes

[0 :256] char

Jean Dupont

accountNumber

Account number. Its format depends on the account type.

We encourage you to use the api method “RegisterIBAN” to add an IBAN. The BBAN corresponds to the second part of the IBAN - after country code and two digits.

Yes

[0 : 34] char

14200410100

holderCountryCountry of the beneficiary. 2 chars ISO country code.

No

2 char

US

bicCode

Si l’accountType = 0 or null, alors le BIC est mandatory.


BIC/SWIFT codes are arranged like this : AAAABBCCDDD

AAAA : 4 char for bank code
BB : 2 char for country code
CC : 2 char for location code
DDD : 3 char for branch code (optional)

Yes

[8 : 11] char


ABCDEFGHIJK
 


bankName

Name of the bank. It is mandatory for the examples below :

  • If the currency of the partner’s environment is USD.

  • If the selected bank country code requires this field (please check “CountriesBankAccountDetailsRules” table)

Depends

[0 :140] char


BANK OF AMERICA

bankCountry

Country of the bank. 2 chars ISO country code.

Yes

2 char

US

bankBranchCode

Branch code of the bank (sort code for United Kingdom). It is mandatory for the examples below :

  • If the selected bank country code requires this field (please check “CountriesBankAccountDetailsRules” table)

Depends

[0 : 255] char

24356758

bankBranchAddressStreet

Address of the bank - Number and street. It is mandatory for the examples below :

  • If the currency of the partner’s environment is USD

  • If the selected bank country code requires this field (please check “CountriesBankAccountDetailsRules” table)

Depends[0 : 128] char222 BROADWAY
bankBranchAddressZipCode

Address of the bank - Zip code. It is mandatory for the examples below :

  • If the currency of the partner’s environment is USD

  • If the selected bank country code requires this field (please check “CountriesBankAccountDetailsRules” table)

Depends[0 : 16] char10038
bankBranchAddressCity

Address of the bank - City. It is mandatory for the examples below :

  • If the currency of the partner’s environment is USD

  • If the selected bank country code requires this field (please check “CountriesBankAccountDetailsRules” table)

Depends[0 : 128] charNEW YORK CITY
intermediaryBicCodeBIC/SWIFT code of the intermediary bank.No[0 : 11] charIRVTDEFX
intermediaryBankName

Name of the intermediary bank.

No[0 :140] charBank OF NEW YORK MELLON
intermediaryBankCountryBank country code of the intermediary bank. 2 chars ISO country code.No2 charsDE
comment

Reason for new bank account details if another one is already linked to the payment account.

No[1 : 512] charPrevious bank account closed

Please find below the list of the error messages. If the mandatory fields are not completed, you will get an error message with the fields missing.

  • Invalid country code : ERR_FORMAT_COUNTRY

  • The selected bank country code requires an IBAN : ERR_MISSING_MANDATORY_IBAN

  • Missing BIC : ERR_BIC_MISSING

  • Missing bank name : ERR_EMPTY_MANDATORY_BANK_NAME

  • Missing bank address information (street, zipcode or city) : ERR_EMPTY_MANDATORY_BANK_BRANCH_ADDRESS

  • Missing bank branch code : RR_EMPTY_MANDATORY_BANK_BRANCH_ROUTING_CODE

Some examples

  • USD environments
    Select “RegisterIBANExtended” and complete all bank info (name, address, bank branch code)

  • Morocco
    Morocco is part of the “transition IBAN countries”. That means some users have an IBAN format for bank details and other an account number. For IBANs, please use “RegisterIBAN” and for other bank details please use “RegisterIBANExtended”.

  • Domestic GBP payments (GBP environments and bank country GB)
    For IBANs, please use “RegisterIBAN” and for other bank details please use “RegisterIBANExtended” and complete account number and bank branch code/sort code.

Answer

  

XML

|
<IBAN>
	<S>5</S>
	<ID>11</ID><!-- since version 1.1--> 
</IBAN> 
  
   

JSON

{  
    "IBAN":{  
        "S":"5",
        "ID":"11"<!-- since version 1.1-->
    }
}