RegisterIbanExtended: Add a Bank Account (all formats) 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 does work?
To send money-outs from the Lemonway payment account to the bank of 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.
If the format of the bank details is an IBAN, we suggest you use the other API method “RegisterIBAN” which requires much fewer mandatory fields.
Depending on your business, the account information may be automatically activated. If it is not, our control team needs to validate it with the uploaded bank document.
By default, you can register multiple Bank Accounts per payment account. When you link a new Bank Account (IBAN format or other ones), the previous ones are still active. Please use UnregisterIBAN method to deactivate a bank account from a payment. If you wish to enforce only one bank account per payment account at the time, please contact Support.
Depending on the bank country code selected or when a USD environment is concerned, 5 fields may be required :
bankBranchCode (or sort code for the UK)
bankName
bankBranchAddressStreet
bankBranchAddressZipCode
bankCity
Please find attached below the list of country codes and associated mandatory fields:
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, | No | 1 char | 0 |
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. | Yes | [0 : 34] char | 14200410100 |
| holderCountry | Country of the beneficiary. 2 chars ISO country code. | No | 2 char | US |
bicCode | If the accountType = 0 or null, the BIC is mandatory.
AAAA : 4 char for bank code | Yes | [8 : 11] char | ABCDEFGHIJK |
bankName | Name of the bank. It is mandatory for the examples below :
| 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 the United Kingdom). It is mandatory for the examples below :
| Depends | [0 : 255] char | 24356758 |
| bankBranchAddressStreet | Address of the bank - Number and street. It is mandatory for the examples below:
| Depends | [0 : 128] char | 222 BROADWAY |
| bankBranchAddressZipCode | Address of the bank - Zip code. It is mandatory for the examples below :
| Depends | [0 : 16] char | 10038 |
| bankBranchAddressCity | Address of the bank - City. It is mandatory for the examples below :
| Depends | [0 : 128] char | NEW YORK CITY |
| intermediaryBicCode | BIC/SWIFT code of the intermediary bank. | No | [0 : 11] char | IRVTDEFX |
| intermediaryBankName | Name of the intermediary bank. | No | [0 :140] char | Bank OF NEW YORK MELLON |
| intermediaryBankCountry | Bank country code of the intermediary bank. 2 chars ISO country code. | No | 2 chars | DE |
| comment | Reason for new bank account details if another one is already linked to the payment account. | No | [1 : 512] char | Previous 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-->
}
}