Add a contact detail

contactType

enum

The type of contact whose details you want to retrieve.
Allowed values:

• financialContact
• shareHolder1
• shareHolder2
• shareHolder3
• shareHolder4

merchantCode

String

A merchant code string holds a value to identify a merchant.

Format:

• Either: MerchantAccount.Merchant_Code
• Or: Merchant_Code

class

A container object for contact type data

This field holds the following child element(s):

• address
• name
• personalData
• PhoneNumber
• fullPhoneNumber
• email
• webAddress

String

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.

String

The email address associated with the user account.

|-webAddress

String

Web address of the contact.

class

A container object for address details.

This field holds the following child element(s):

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

|-city

String

The city the contact operates from.

|-country

String

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

House number or name of the building the contact operates from.

|-postalCode

String

ZIP code.

Character limitations:

• US ZIP code: max. 5 chars.
• Any other country/region: max. 10 chars.

String

State, region or province the contact operates from.

String

Street address.

class

A container object for personal data

• firstName
• lastName

|-firstName

String

The first name/given name of the user.

• Max. length: 80 characters

|-lastName

String

The last name/family name of the user.

• Max. length: 80 characters

class

A container object for personal information details.

• dateOfBirth
• idNumber
• nationality

|-dateOfBirth

class

The shopper's date of birth.

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

|-idNumber

String

A unique identifier for the contact type.

|-nationality

String

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. 

class

A container object for telephone details.

This field holds the following child element(s):

• phoneCountryCode
• phoneNumber
• phoneType

|-phoneCountryCode

String

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

Telephone number, without the country code.

|-phoneType

enum

Telephone line type.
Allowed values:

• Landline
• Mobile
• SIP
• Fax

pspReference

String

A reference to uniquely identify the request.

warnings

String

List containing one or more warning messages.
Returned when the request is not correctly processed.

errors

String

List containing one or more error messages.
Returned when the request fails.