Search

Are you looking for test card numbers?

Would you like to contact support?

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: 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
  • gender
  • infix
  • 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

|-infix

String
-x-
Infix in the user account's name.
  • Max. length: 20 characters

|-gender

enum
-white_check_mark-
Defines the gender of the user.
Allowed values:
  • MALE
  • FEMALE
  • UNKNOWN
|-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.

Name Type Returned by default Description
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

{  
  "contact":{  
    "address":{  
      "city":"Amsterdam",
      "country":"NL",
      "houseNumberOrName":"1",
      "postalCode":"1111",
      "stateOrProvince":"AA",
      "street":"Erstestraat"
    },
    "email":"john.doe@testshop.nl",
    "name":{  
      "firstName":"John",
      "gender":"MALE",
      "lastName":"Doe"
    },
    "personalData":{  
      "dateOfBirth":"1920-02-20",
      "idNumber":"NL987654321",
      "nationality":"NL"
    },
    "phoneNumber":{  
      "phoneCountryCode":"NL",
      "phoneNumber":"11 22 33 44",
      "phoneType":"Landline"
    },
    "webAddress":"http:\/\/testshop.nl"
  },
  "contactType":"shareHolder4",
  "merchantCode":"TestMerchant"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <addContactDetail xmlns="http://caaccount.services.adyen.com">
      <request>
        <contact>
          <address xmlns="http://common.services.adyen.com">
            <city>Amsterdam</city>
            <country>NL</country>
            <houseNumberOrName>1</houseNumberOrName>
            <postalCode>1111</postalCode>
            <stateOrProvince>AA</stateOrProvince>
            <street>Erstestraat</street>
          </address>
          <email xmlns="http://common.services.adyen.com">john.doe@testshop.nl</email>
          <name xmlns="http://common.services.adyen.com">
            <firstName>John</firstName>
            <gender>MALE</gender>
            <lastName>Doe</lastName>
          </name>
          <personalData xmlns="http://common.services.adyen.com">
            <dateOfBirth>1920-02-20</dateOfBirth>
            <nationality>NL</nationality>
            <idNumber>NL987654321</idNumber>
          </personalData>
          <phoneNumber xmlns="http://common.services.adyen.com">
            <phoneCountryCode>NL</phoneCountryCode>
            <phoneNumber>11 22 33 44</phoneNumber>
            <phoneType>Landline</phoneType>
          </phoneNumber>
          <webAddress xmlns="http://common.services.adyen.com">http://testshop.nl</webAddress>
        </contact>
        <contactType>shareHolder4</contactType>
        <merchantCode>TestMerchant</merchantCode>
      </request>
    </addContactDetail>
  </soap:Body>
</soap:Envelope>

Response

{  
   "pspReference":"9914526964210620"
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://caaccount.services.adyen.com" xmlns:ns1="http://common.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns0:addContactDetailResponse>
      <ns0:response>
        <ns0:pspReference>9914526964210620</ns0:pspReference>
      </ns0:response>
    </ns0:addContactDetailResponse>
  </soap:Body>
</soap:Envelope>

Response in case of an error or warning

{  
  "pspReference":"9914140680120319",
  "warnings":{  
    "string":"contact.webAddress is not required for contactType financialContact, ignoring"
  }
}
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://caaccount.services.adyen.com" xmlns:ns1="http://common.services.adyen.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <ns0:addContactDetailResponse>
      <ns0:response>
        <ns0:pspReference>9914140680120319</ns0:pspReference>
        <ns0:warnings>
          <ns0:string>contact.webAddress is not required for contactType financialContact, ignoring</ns0:string>
        </ns0:warnings>
      </ns0:response>
    </ns0:addContactDetailResponse>
  </soap:Body>
</soap:Envelope>