POST
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
bankaccounts
/
iban

Caution – Only for countries that use IBAN

Only use the IBAN type for accounts registered in countries that use IBAN and aren’t GB, US, or CA (for which you should use the dedicated type). 

Path parameters

UserId
string
required

The unique identifier of the User (natural or legal) who owns the bank account.

Body parameters

OwnerAddress
object
required

Information about the address of residence of the bank account owner.

IBAN
string
required

Length: Up to 34 characters

The IBAN (international bank account number) of the bank account. It follows the CCDDBBAN format in which:

  • CC represents the country code (ISO 3166-1 alpha 2)
  • DD represents two check digits used by banking systems to avoid simple errors
  • BBAN stands for the Basic Bank Account Number which is up to 30 alphanumeric characters that are country-specific.
    Note: You will need a valid IBAN (i.e., existing in real life) when testing on a Sandbox account even if no actual payout will be processed.
BIC
string

The BIC (international identifier of the bank) for IBAN or OTHER-type bank accounts.
The BIC can have one of the two following formats:

  • BIC8 – 8-character BIC (AAAABBCC)
  • BIC11 – 11-character BIC (AAAABBCCDDD)
    In which:
  • AAAA represents the bank code: 4 characters defining the bank
  • BB represents the country code: 2 characters forming the country ISO code (ISO 3166 format)
  • CC represents the location code: 2 localization characters (alphabetical or numeric) to distinguish banks from the same country
  • DDD represents the branch code: 3 optional characters defining the branch as a branch of the bank
OwnerName
string
required

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Tag
string

Max. length: 255 characters

Custom data that you can add to this object.
For bank accounts, you can use this parameter to identify the bank account by currency or usage (personal or professional for instance).

Responses