addContactDetail request

addContactDetail request fields

To insert additional details in a the record of the specified contact type associated to a merchant account, pass the following fields:

Name Type Required Description
contactType enum (tick)
The type of contact whose details you want to retrieve.
Allowed values:
  • financialContact
  • shareHolder1
  • shareHolder2
  • shareHolder3
  • shareHolder4
merchantCode String (tick)
A merchant code string holds a value to identify a merchant.

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code
contact class (tick)
A container object for contact type data

This field holds the following child element(s):

  • address
  • name
  • personalData
  • PhoneNumber
  • fullPhoneNumber
  • email
  • webAddress
address class (tick)
A container object for address details.

This field holds the following child element(s):

  • city
  • country
  • houseNumberOrName
  • postalCode
  • stateOrProvince
  • street
city String (tick)  The city the contact operates from.
country String (tick)

 The country the contact operates from.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO website.

houseNumberOrName String (tick)  House number or name of the building the contact operates from.
postalCode String (tick)
ZIP code.

Character limitations:

  • US ZIP code: max. 5 chars.
  • Any other country: max. 10 chars.
stateOrProvince String (tick)
State, region or province the contact operates from.
Character limitations:
  • US and Canada: max. 2 chars.
  • Any other country: max. 3 chars.
street String (tick) Street address. 
name class (tick)

A container object for personal data

  • firstName
  • gender
  • infix
  • lastName

firstName String (tick) The first name/given name of the user.
  • Max. length: 80 characters
lastName String (tick) The last name/family name of the user.
  • Max. length: 80 characters
infix String (error) Infix in the user account's name.
  • Max. length: 20 characters
gender enum (tick)
Defines the gender of the user.
Allowed values:
  • MALE
  • FEMALE
  • UNKNOWN
personalData class (error) A container object for personal information details.
  • dateOfBirth
  • idNumber
  • nationality
dateOfBirth class (error) The shopper's date of birth.

Format: ISO-8601; example: YYYY-MM-DD

idNumber String (error) A unique identifier for the contact type.
nationality String (error)

Nationality of the contact.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO website.

PhoneNumber class (error)
A container object for telephone details.

This field holds the following child element(s):

  • phoneCountryCode
  • phoneNumber
  • phoneType
phoneCountryCode String (error)

The country the phone line operates from.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO website.

phoneNumber String (error) Telephone number, without the country code.
phoneType enum (error)
Telephone line type.
Allowed values:
  • Landline
  • Mobile
  • SIP
  • Fax
fullPhoneNumber String (tick)
Complete telephone number, i.e. country code + area code + phone number , represented as one string.
For example: 0031 6 11 22 33 44; +316/1122-3344; (0031) 611223344.

It is handled as a Landline phone type.
Max. length: 14 chars.

email String (error)

The email address associated with the user account.

email is mandatory for the financialContact contact type.

webAddress String (error) Web address of the contact.