No momento, esta página não está disponível em português
Default icon

Add a contact detail

Add contact details to a financial or shareholder contact for a merchant account.

Request parameters

To send additional details in the record of the specified contact type associated with a merchant account, make a POST /addContactDetail request specifying:

Name Type
Required
Description

contactType

enum

-white_check_mark-

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

  • financialContact
  • shareHolder1
  • shareHolder2
  • shareHolder3
  • shareHolder4

merchantCode

String

-white_check_mark-

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

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code
contact

class

-white_check_mark-

A container object for contact type data

This field holds the following child element(s):

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

String

-white_check_mark-

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

-x-

The email address associated with the user account.

|-webAddress

String

-x-

Web address of the contact.

|-address

class

-white_check_mark-

A container object for address details.

This field holds the following child element(s):

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

|-city

String

-white_check_mark-

The city the contact operates from.

|-country

String

-white_check_mark-

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

-white_check_mark-

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

|-postalCode

String

-white_check_mark-

ZIP code.

Character limitations:

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

String

-white_check_mark-

State, region or province the contact operates from.

|-street

String

-white_check_mark-

Street address.

|-name

class

-white_check_mark-

A container object for personal data

  • firstName
  • lastName

|-firstName

String

-white_check_mark-

The first name/given name of the user.

  • Max. length: 80 characters

|-lastName

String

-white_check_mark-

The last name/family name of the user.

  • Max. length: 80 characters
|-personalData

class

-x-

A container object for personal information details.

  • dateOfBirth
  • idNumber
  • nationality

|-dateOfBirth

class

-x-

The shopper's date of birth.

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

|-idNumber

String

-x-

A unique identifier for the contact type.

|-nationality

String

-x-

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

-x-

A container object for telephone details.

This field holds the following child element(s):

  • phoneCountryCode
  • phoneNumber
  • phoneType

|-phoneCountryCode

String

-x-

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

-x-

Telephone number, without the country code.

|-phoneType

enum

-x-

Telephone line type.
Allowed values:

  • Landline
  • Mobile
  • SIP
  • Fax

Response parameters

If there are no errors in the request, the call returns a pspReference.If any issues occur during the process, the call returns one or more warning or error messages.

NameTypeReturned by defaultDescription

pspReference

String

-white_check_mark-

A reference to uniquely identify the request.

warnings

String

-x-

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

errors

String

-x-

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

Examples

Request

Response

Response in case of an error or warning