Add a Bank Account (all formats) to a Payment Account for Money-Outs
RegisterIbanExtended
How it works
To send Money-Outs from the Lemonway payment account to the bank of your clients, you need to register their bank details. With the 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 Add a Bank Account (IBAN format) to a Payment Account for Money-Outs 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 Disable a Bank Account (IBAN or another format) from a Payment Account 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.
Nice to know!
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
Download our zipped .xlsx file that list of country codes and associated mandatory fields
XML
<Request>
<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>
</Request>
<Response>
<IBAN>
<S>5</S>
<ID>11</ID><!-- since version 1.1-->
</IBAN>
</Response>
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"
}
{
"IBAN": {
"S": "5",
"ID": "11" <!-- since version 1.1 -->
}
}
Request Input Description
Item | Description | Mandatory | Format | Example |
---|---|---|---|---|
wallet | Payment account ID | Yes | [0: 256] char | 33612345678 ou taxi67 |
accountType | Account type, by default Other. | No | 1 char | 0 |
holderName | The registered bank account owner | Yes | [0:256] char | Jean Dupont |
accountNumber | Account number | Yes | [0: 34] char | 14200410100 |
holderCountry | Country of the beneficiary | No | 2 char | US |
bicCode | BIC is mandatory if accountType = 0 or null | Yes | [8 : 11] char | ABCDEFGHIJK |
Please find below the list of the error messages
- 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: ERR_EMPTY_MANDATORY_BANK_BRANCH_ADDRESS
- Missing bank branch code: ERR_EMPTY_MANDATORY_BANK_BRANCH_ROUTING_CODE
Examples
- USD environments - Select “RegisterIBANExtended” and complete all bank info (name, address, bank branch code)
- Morocco - For IBANs, use “RegisterIBAN” and for other bank details use “RegisterIBANExtended”.
- Domestic GBP payments (GBP environments and bank country GB) - Use “RegisterIBAN” for IBANs and “RegisterIBANExtended” for other details.