getContactDetail response

getContactDetail response fields

If there are no errors in the request, the call returns detailed information about the requested contact.
If any issues occur during the process, the call returns one or more warning or error messages.

Name Type Returned by default Description
contact
class (error)
A container object for contact type data

This field holds the following child element(s):

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

This field holds the following child element(s):

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

city

String (error) The city the contact operates from.

country

String (error)

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 (error) House number or name of the building the contact operates from.

postalCode

String (error)
ZIP code.

Character limitations:

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

stateOrProvince

String (error) State, region or province the contact operates from.

street

String (error) Street address.
name
class (error) A container object for personal data
  • firstName
  • gender
  • infix
  • lastName

firstName

String (error) The first name/given name of the user.
  • Max. length: 80 characters

lastName

String (error) 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 (error)
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 (error)
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.

webAddress

String (error) Web address of the contact.
pspReference String (tick) A reference to uniquely identify the request.
warnings
String (error)
List containing one or more warning messages.
Returned when the request is not correctly processed.
errors
String (error)
List containing one or more error messages.
Returned when the request fails.