{"title":"Add a contact detail","category":"default","creationDate":1776961629,"content":"

Request parameters<\/h2>\n

To send additional details in the record of the specified contact type associated with a merchant account,\u00a0make a POST \/addContactDetail<\/code> request specifying:<\/p>\n\n \n \n
Name<\/th>\n Type<\/th>\n
Required<\/center><\/th>\n
Description<\/th>\n <\/tr>\n

contactType<\/code>
\n <\/p><\/td>

\n

enum<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The type of contact whose details you want to retrieve.
\nAllowed values:<\/p>\n

    \n
  • financialContact<\/code><\/li>\n
  • shareHolder1<\/code><\/li>\n
  • shareHolder2<\/code><\/li>\n
  • shareHolder3<\/code><\/li>\n
  • shareHolder4<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n

merchantCode<\/code>
\n <\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

A merchant code string holds a value to identify a merchant.<\/p>\n

Format:<\/p>\n

    \n
  • Either: MerchantAccount.Merchant_Code<\/code><\/li>\n
  • Or: Merchant_Code<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n
contact<\/code>
\n<\/td>		\n

class<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

A container object for\u00a0contact type data<\/p>\n

This field holds the following child element(s):<\/p>\n

    \n
  • address<\/code><\/li>\n
  • name<\/code><\/li>\n
  • personalData<\/code><\/li>\n
  • PhoneNumber<\/code><\/li>\n
  • fullPhoneNumber<\/code><\/li>\n
  • email<\/code><\/li>\n
  • webAddress<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td>|-fullPhoneNumber<\/code><\/td>\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

Complete telephone number, i.e. country code + area code + phone number<\/em>, represented as one string.
\nFor example: 0031 6 11 22 33 44<\/em>; +316\/1122-3344<\/em>; (0031) 611223344.<\/em><\/p>\n

It is handled as a\u00a0Landline<\/code> phone type.
\nMax. length: 14 chars. <\/p>\n<\/td><\/tr>\n

<\/td>|-email<\/code><\/td>\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

The email address associated with the user account.<\/p>\n<\/td><\/tr>\n

<\/td>

|-webAddress<\/code>
\n <\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

Web address of the contact.<\/p>\n<\/td><\/tr>\n

<\/td>|-address<\/code>
\n<\/td>		\n

class<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

A container object for\u00a0address details.<\/p>\n

This field holds the following child element(s):<\/p>\n

    \n
  • city<\/code><\/li>\n
  • country<\/code><\/li>\n
  • houseNumberOrName<\/code><\/li>\n
  • postalCode<\/code><\/li>\n
  • stateOrProvince<\/code><\/li>\n
  • street<\/code><\/li>\n<\/ul>\n<\/td><\/tr>
<\/td><\/td>

|-city<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The city the contact operates from.<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-country<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The country the contact operates from.
The country<\/code> value format needs to adhere to the ISO 3166-1 alpha-2<\/a> standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes<\/a> on the ISO website.
<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-houseNumberOrName<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

House number or name of the building the contact operates from.<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-postalCode<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

ZIP code.<\/p>\n

Character limitations:<\/p>\n

    \n
  • US ZIP code: max. 5 chars.<\/li>\n
  • Any other country\/region: max. 10 chars.<\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td><\/td>|-stateOrProvince<\/code><\/td>\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

State, region or province the contact operates from.<\/p>\n<\/td><\/tr>\n

<\/td><\/td>|-street<\/code><\/td>\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

Street address.<\/p>\n<\/td><\/tr>\n

<\/td>|-name<\/code>
\n<\/td>		\n

class<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

A container object for\u00a0personal data<\/p>\n

    \n
  • firstName<\/code><\/li>\n
  • lastName<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td><\/td>

|-firstName<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The first name\/given name of the user.<\/p>\n

    \n
  • Max. length: 80 characters<\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td><\/td>

|-lastName<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The last name\/family name of the user.<\/p>\n

    \n
  • Max. length: 80 characters<\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td>|-personalData<\/code>
\n<\/td>		\n

class<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

A container object for\u00a0personal information details.<\/p>\n

    \n
  • dateOfBirth<\/code><\/li>\n
  • idNumber<\/code><\/li>\n
  • nationality<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td><\/td>

|-dateOfBirth<\/code>
\n<\/p><\/td>

\n

class<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

The shopper's date of birth.<\/p>\n

Format:\u00a0ISO-8601<\/a>; example: YYYY-MM-DD<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-idNumber<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

A unique identifier for the contact type.<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-nationality<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

Nationality of the contact.The country<\/code> value format needs to adhere to the ISO 3166-1 alpha-2<\/a> standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes<\/a> on the ISO website.\u00a0<\/p>\n<\/td><\/tr>\n

<\/td>|-PhoneNumber<\/code>
\n<\/td>		\n

class<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

A container object for\u00a0telephone details.<\/p>\n

This field holds the following child element(s):<\/p>\n

    \n
  • phoneCountryCode<\/code><\/li>\n
  • phoneNumber<\/code><\/li>\n
  • phoneType<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n
<\/td><\/td>

|-phoneCountryCode<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

The country the phone line operates from.The country<\/code> value format needs to adhere to the ISO 3166-1 alpha-2<\/a> standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes<\/a> on the ISO website.<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-phoneNumber<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

Telephone number, without the country code.<\/p>\n<\/td><\/tr>\n

<\/td><\/td>

|-phoneType<\/code>
\n<\/p><\/td>

\n

enum<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

Telephone line type.
\nAllowed values:<\/p>\n

    \n
  • Landline<\/code><\/li>\n
  • Mobile<\/code><\/li>\n
  • SIP<\/code><\/li>\n
  • Fax<\/code><\/li>\n<\/ul>\n<\/td><\/tr>\n<\/tbody><\/table>\n

    Response parameters<\/h2>\n

    If there are no errors in the request, the call returns\u00a0a\u00a0pspReference.<\/code>If any issues occur during the process, the call returns one or more warning or error messages.<\/p>\n
    Name<\/th>Type<\/th>Returned\u00a0by\u00a0default<\/th>Description<\/th><\/tr><\/thead>
    \n

    pspReference<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    A reference to uniquely identify the request.<\/p>\n<\/td><\/tr>

    \n

    warnings<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more warning messages.
    \nReturned when the request is not correctly processed.<\/p>\n<\/td><\/tr>

    \n

    errors<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more error messages.
    \nReturned when the request fails.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

    Examples<\/h2>\n

    Request<\/h3>\n
    \n <\/code-sample>\n<\/div>\n

    Response<\/h3>\n
    \n <\/code-sample>\n<\/div>\n

    Response in case of an error or warning<\/h3>\n
    \n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-contact-details\/addcontactdetail","articleFields":{"id":"25135024","type":"page","description":"Add contact details to a financial or shareholder contact for a merchant account.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-contact-details\/addcontactdetail","title":"Add a contact detail","content":"Request parameters\nTo send additional details in the record of the specified contact type associated with a merchant account,\u00a0make a POST \/addContactDetail request specifying:\n\n \n \n Name\n Type\n Required\n Description\n \n contactType\n \nenum\n\n\n\nThe type of contact whose details you want to retrieve.\nAllowed values:\n\nfinancialContact\nshareHolder1\nshareHolder2\nshareHolder3\nshareHolder4\n\n\n merchantCode\n \nString\n\n\n\nA merchant code string holds a value to identify a merchant.\nFormat:\n\nEither: MerchantAccount.Merchant_Code\nOr: Merchant_Code\n\n\n contact\n\nclass\n\n\n\nA container object for\u00a0contact type data\nThis field holds the following child element(s):\n\naddress\nname\npersonalData\nPhoneNumber\nfullPhoneNumber\nemail\nwebAddress\n\n\n|-fullPhoneNumber\nString\n\n\n\nComplete telephone number, i.e. country code + area code + phone number, represented as one string.\nFor example: 0031 6 11 22 33 44; +316\/1122-3344; (0031) 611223344.\nIt is handled as a\u00a0Landline phone type.\nMax. length: 14 chars. \n\n|-email\nString\n\n\n\nThe email address associated with the user account.\n\n |-webAddress\n \nString\n\n\n\nWeb address of the contact.\n\n|-address\n\nclass\n\n\n\nA container object for\u00a0address details.\nThis field holds the following child element(s):\n\ncity\ncountry\nhouseNumberOrName\npostalCode\nstateOrProvince\nstreet\n\n|-city\n\nString\n\n\n\nThe city the contact operates from.\n\n|-country\n\nString\n\n\n\nThe country the contact operates from.The country value format needs to adhere to the ISO 3166-1 alpha-2 standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes on the ISO website.\n\n|-houseNumberOrName\n\nString\n\n\n\nHouse number or name of the building the contact operates from.\n\n|-postalCode\n\nString\n\n\n\nZIP code.\nCharacter limitations:\n\nUS ZIP code: max. 5 chars.\nAny other country\/region: max. 10 chars.\n\n\n|-stateOrProvince\nString\n\n\n\nState, region or province the contact operates from.\n\n|-street\nString\n\n\n\nStreet address.\n\n|-name\n\nclass\n\n\n\nA container object for\u00a0personal data\n\nfirstName\nlastName\n\n\n|-firstName\n\nString\n\n\n\nThe first name\/given name of the user.\n\nMax. length: 80 characters\n\n\n|-lastName\n\nString\n\n\n\nThe last name\/family name of the user.\n\nMax. length: 80 characters\n\n\n|-personalData\n\nclass\n\n\n\nA container object for\u00a0personal information details.\n\ndateOfBirth\nidNumber\nnationality\n\n\n|-dateOfBirth\n\nclass\n\n\n\nThe shopper's date of birth.\nFormat:\u00a0ISO-8601; example: YYYY-MM-DD\n\n|-idNumber\n\nString\n\n\n\nA unique identifier for the contact type.\n\n|-nationality\n\nString\n\n\n\nNationality of the contact.The country value format needs to adhere to the ISO 3166-1 alpha-2 standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes on the ISO website.\u00a0\n\n|-PhoneNumber\n\nclass\n\n\n\nA container object for\u00a0telephone details.\nThis field holds the following child element(s):\n\nphoneCountryCode\nphoneNumber\nphoneType\n\n\n|-phoneCountryCode\n\nString\n\n\n\nThe country the phone line operates from.The country value format needs to adhere to the ISO 3166-1 alpha-2 standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes on the ISO website.\n\n|-phoneNumber\n\nString\n\n\n\nTelephone number, without the country code.\n\n|-phoneType\n\nenum\n\n\n\nTelephone line type.\nAllowed values:\n\nLandline\nMobile\nSIP\nFax\n\n\n\nResponse parameters\nIf there are no errors in the request, the call returns\u00a0a\u00a0pspReference.If any issues occur during the process, the call returns one or more warning or error messages.\nNameTypeReturned\u00a0by\u00a0defaultDescription\npspReference\n\nString\n\n\n\nA reference to uniquely identify the request.\n\nwarnings\n\nString\n\n\n\nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\nerrors\n\nString\n\n\n\nList containing one or more error messages.\nReturned when the request fails.\n\nExamples\nRequest\n\n \n\nResponse\n\n \n\nResponse in case of an error or warning\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage contact details","lvl3":"Add a contact detail"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/account-management-api","lvl2":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-contact-details","lvl3":"\/pt\/account-management-api\/manage-contact-details\/addcontactdetail"},"levels":4,"category":"","category_color":"","tags":["contact","detail"]},"articleFiles":{"46092193.json":"

    46092193.json<\/p>","139108197.json":"

    139108197.json<\/p>","1913649844.json":"

    1913649844.json<\/p>"}}