addShareholders

Sets shareholder contact information for a given Merchant Account. Please note that it is possible to add information for up to 4 shareholders. Only the following field has to be provided.

  • shareholderData

shareHolderData Element fields

Fields Type Required Description

merchantCode

String (tick) The merchantCode is the name of the merchant account and is based on the tradingName. This field is mandatory when calling addShareholders.
shareHolders Class (tick)

Container for the shareholder's contact information. It can contain up to four fields of the following type:

  • contact
contact Class (tick)

Contact information. The following fields are required:

  • address
  • name
  • personalData
  • phoneNumber
address Class (tick)

Address of the shareholder. The following fields are required:

  • city
  • country
  • houseNumberOrName
  • postalCode
  • stateOrProvince
  • street

city

String (tick) City of the shareholder.
country String (tick) Country of the shareholder. A valid value is an ISO 2-character country code.

houseNumberOrName

String (tick) House name or number of the shareholder.
postalCode String (tick) Postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.

stateOrProvince

String (tick)

For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation with maximum 3 characters for the state or province.

street String (tick) Street name.
email String (tick) Email of the shareholder.
name Class (tick)

Full name of the user. The following fields are required:

  • firstName
  • lastName
  • gender

firstName

String (tick) First name of the user.

lastName

String (tick) Last name of the user.
gender String (tick) enum { 'MALE', 'FEMALE', 'UNKNOWN' }.
personalData Class (error)

Personal information of the user. The following fields are required:

  • dateOfBirth
  • idNumber
  • nationality

dateOfBirth

String (error) The date of birth of the shareholder, the date should be in ISO format yyyy-mm-dd (e.g. 2000-01-31).

idNumber

String (error) An ID number of the shareholder.

nationality

String (error) Nationality of the shareholder represented by an ISO 2-character country code (e.g. 'NL').

phoneNumber

Class (tick)

Either phoneNumber or fullPhoneNumber should be provided. The phone number length needs to be at least 6 characters long, including the + leading symbol.

The following fields are required:

  • phoneCountryCode
  • phoneNumber
  • phoneType

phoneCountryCode

String (tick) A valid value is an ISO 2-character country code (e.g. 'NL').

phoneNumber

String (tick) No need to include the country code in the number (e.g. '06-11223344').

phoneType

String (tick) enum { 'Landline', 'Mobile', 'SIP', 'Fax' }

fullPhoneNumber

String (tick) Either phoneNumber or fullPhoneNumber has to be provided. The full phone number is a string handled as a landline phoneType (e.g. "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344").

Refer the given code examples.