Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Get a contact detail

Get the contact details of a financial or shareholder contact.

Request parameters

To get the contact details of a contact type associated with a merchant account, make a POST /getContactDetail 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

Response parameters

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
pspReference String
-white_check_mark-
A reference to uniquely identify the request.
contact
class
-x-
A container object for contact type data This field holds the following child element(s):
  • address
  • name
  • personalData
  • PhoneNumber
  • fullPhoneNumber
  • email
  • webAddress
|-fullPhoneNumber String
-x-
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
-x-
A container object for address details. This field holds the following child element(s):
  • city
  • country
  • houseNumberOrName
  • postalCode
  • stateOrProvince
  • street

|-city

String
-x-
The city the contact operates from.

|-country

String
-x-

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

|-postalCode

String
-x-
ZIP code. Character limitations:
  • US ZIP code: max. 5 chars.
  • Any other country: max. 10 chars.
|-stateOrProvince String
-x-
State, region or province the contact operates from.
|-street String
-x-
Street address.
|-name
class
-x-
A container object for personal data
  • firstName
  • gender
  • infix
  • lastName

|-firstName

String
-x-
The first name/given name of the user.
  • Max. length: 80 characters

|-lastName

String
-x-
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
-x-
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
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

{  
   "contactType":"financialContact",
   "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>
    <getContactDetail xmlns="http://caaccount.services.adyen.com">
      <request>
        <contactType>financialContact</contactType>
        <merchantCode>TestMerchant</merchantCode>
      </request>
    </getContactDetail>
  </soap:Body>
</soap:Envelope> 

Response

{
   "pspReference":"9914526964220637",
   "contact":{
      "address":{
         "city":"Amsterdam",
         "country":"NL",
         "postalCode":"1111",
         "street":"Erstestraat 1"
      },
      "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":"11223344",
         "phoneType":"Landline"
      },
      "webAddress":"http:\/\/testshop.nl"
   }
}
<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:getContactDetailResponse>
      <ns0:response>
        <ns0:pspReference>9914526964220637</ns0:pspReference>
        <ns0:contact>
          <ns1:address>
            <ns1:city>Amsterdam</ns1:city>
            <ns1:country>NL</ns1:country>
            <ns1:postalCode>1111</ns1:postalCode>
            <ns1:street>Erstestraat 1</ns1:street>
          </ns1:address>
          <ns1:email>john.doe@testshop.nl</ns1:email>
          <ns1:name>
            <ns1:firstName>John</ns1:firstName>
            <ns1:gender>MALE</ns1:gender>
            <ns1:lastName>Doe</ns1:lastName>
          </ns1:name>
          <ns1:personalData>
            <ns1:dateOfBirth>1920-02-20</ns1:dateOfBirth>
            <ns1:idNumber>NL987654321</ns1:idNumber>
            <ns1:nationality>NL</ns1:nationality>
          </ns1:personalData>
          <ns1:phoneNumber>
            <ns1:phoneCountryCode>NL</ns1:phoneCountryCode>
            <ns1:phoneNumber>11223344</ns1:phoneNumber>
            <ns1:phoneType>Landline</ns1:phoneType>
          </ns1:phoneNumber>
          <ns1:webAddress>http://testshop.nl</ns1:webAddress>
        </ns0:contact>
      </ns0:response>
    </ns0:getContactDetailResponse>
  </soap:Body>
</soap:Envelope>