Cardholders

Update Cardholder

Changed on

Updates cardholder details.

patch/cardholders/{cardholderId}

Request

Path parameters

cardholderIdstring uuid required

The unique identifier of the cardholder.

Query parameters

organizationIdstring uuid required

The unique identifier of the organization.

Request body

salutation'MR' | 'MRS'

Used mainly for email communication.

firstNamestring required

The first name of the cardholder. This will be printed on credit cards as the cardholder. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.- The combined length of first name and last name must not exceed 24 characters. One additional character is reserved for the space inserted between them when displayed on the card (25 characters in total). The full legal first name must be provided, since it is used for sanctions screening. Initial-only values are rejected: a single letter (e.g. K), a single letter followed by a period (e.g. K.) and sequences of initials with or without periods (e.g. J R, J. R.). Short names with two or more letters (e.g. Li, Ng, Wu, Xu) are valid. A violation results in a 400 Bad Request with the error code INCOMPLETE_LEGAL_NAME.

lastNamestring required

The last name of the cardholder. This will be printed on credit cards as the cardholder. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.- The combined length of first name and last name must not exceed 24 characters. One additional character is reserved for the space inserted between them when displayed on the card (25 characters in total). The full legal last name must be provided, since it is used for sanctions screening. Initial-only values are rejected: a single letter (e.g. K), a single letter followed by a period (e.g. K.) and sequences of initials with or without periods (e.g. J R, J. R.). Short names with two or more letters (e.g. Li, Ng, Wu, Xu) are valid. A violation results in a 400 Bad Request with the error code INCOMPLETE_LEGAL_NAME.

emailstring required

The email address of the cardholder. This will be used for email communication. If the email address is updated for cardholder that has been invited via API or Pliant apps, an email notification is triggered.

phoneNumberstring required

The phone number must start with + followed by 8 to 15 numbers, e.g. +49123456789. If the phone number of a cardholder is updated, who was invited via Pliant and not the API, the phone number is not changed immediately, but the cardholder will receive an email instead with instructions to re-login to Pliant's web app and to update the phone number there. This is necessary as a security precaution, since the phone number is a critical part of the 3DS authentication process for handling purchases with a credit card.

language'en' | 'de' | 'es' | 'fi' | 'fr' | 'it' | 'pt' | 'nl' | 'et' | 'el' | 'lv' | 'lt' | 'sk' | 'sl' | 'pl' | 'hu' required

Used for setting the language in Pliant apps as well as for email communication.

locale'en-US' nullable

Optional locale. When provided, its language subtag must match language.

isOwnerboolean

If true, the cardholder is the owner of the organization. The owner is allowed to administer all settings of the organization on the Pliant platform. If false, the cardholder is a plain cardholder with limited rights on the Pliant platform. Only works if cardholder was invited via API or Pliant apps.

dateOfBirthstring date nullable

The date-of-birth of the cardholder. Depending on the compliance configuration of your payment program, this field may be required. Omitting it in those cases will result in a 400 Bad Request.

nationalitystring nullable

The nationality of the cardholder (ISO 3166-1 alpha-2). Depending on the compliance configuration of your payment program, this field may be required. Omitting it in those cases will result in a 400 Bad Request.

Example request

{
  "locale": "en-US"
}

Response

Cardholder successfully updated.

cardholderIdstring uuid

The unique identifier of the cardholder.

salutation'MR' | 'MRS' nullable

The salutation of the cardholder. Mainly used for email communication.

firstNamestring

The first name of the cardholder. This will be printed on credit cards as the cardholder. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.- The combined length of first name and last name must not exceed 24 characters. One additional character is reserved for the space inserted between them when displayed on the card (25 characters in total).

lastNamestring

The last name of the cardholder. This will be printed on credit cards as the cardholder. It is important to note, that only the following characters are allowed for issuing cards: A-Z, a-z, 0-9, äöüÄÖÜ.- The combined length of first name and last name must not exceed 24 characters. One additional character is reserved for the space inserted between them when displayed on the card (25 characters in total).

emailstring

The email address of the cardholder. This will be used for email communication.

phoneNumberstring

Phone number must start with + followed by 8 to 15 numbers, e.g. +49123456789. Important! When changing the phone number, the new phone number must be verified by the cardholder within Pliant, if the cardholder has access to Pliant web app. If the cardholder has no access to Pliant, the phone number is changed without an additional verification, but with a short delay of some seconds. You will receive a callback once the cardholder is fully updated.

language'en' | 'de' | 'es' | 'fi' | 'fr' | 'it' | 'pt' | 'nl' | 'et' | 'el' | 'lv' | 'lt' | 'sk' | 'sl' | 'pl' | 'hu'

Used for setting the language in Pliant apps as well as for email communication.

locale'en-US' nullable

Optional locale. When provided, its language subtag must match language.

eligibleForPlatformFeeCardsboolean

Describes if the cardholder is eligible to have platform fee cards assigned to them. Note, that this field depends on the organization. The combination of cardholderId and organizationId defines if this field is true or false.

isOwnerboolean

If true, the cardholder is the owner of the organization. The owner is allowed to administer all settings of the organization on the Pliant platform. If false, the cardholder is a plain cardholder with limited rights on the Pliant platform.

status'INVITED' | 'ACTIVE' | 'DEACTIVATED' | 'CANCELLED'

The status of the cardholder.

isEmbeddedboolean

Describes if the cardholder is embedded with a partner and thus can only be managed via the API. If true, it can only be managed via API, if false, if can be managed via UI as well and the cardholder can also log into Pliant web app.

dateOfBirthstring date nullable

The date-of-birth of the cardholder.

nationalitystring nullable

The nationality of the cardholder (ISO 3166-1 alpha-2).

Example response

{
  "locale": "en-US"
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • warning

      added the new CANCELLED enum value to the / response property for the response status

    • warning

      added the new hu enum value to the / response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new hu enum value to the request property

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status