1
0
Files
PayPal-PHP-Server-SDK/doc/models/payer-name.md
Patrick Powers 1fc2cf1e07 2.0.0 Release (#58)
* Automated commit message

* Automated commit message

* add changelog

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2025-11-13 16:32:53 -06:00

2.1 KiB

Payer Name

The name of the party.

Structure

PayerName

Fields

Name Type Tags Description Getter Setter
prefix ?string Optional The prefix, or title, to the party's name.

Constraints: Maximum Length: 140
getPrefix(): ?string setPrefix(?string prefix): void
givenName ?string Optional When the party is a person, the party's given, or first, name.

Constraints: Maximum Length: 140
getGivenName(): ?string setGivenName(?string givenName): void
surname ?string Optional When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Constraints: Maximum Length: 140
getSurname(): ?string setSurname(?string surname): void
middleName ?string Optional When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Constraints: Maximum Length: 140
getMiddleName(): ?string setMiddleName(?string middleName): void
suffix ?string Optional The suffix for the party's name.

Constraints: Maximum Length: 140
getSuffix(): ?string setSuffix(?string suffix): void
alternateFullName ?string Optional DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

Constraints: Maximum Length: 300
getAlternateFullName(): ?string setAlternateFullName(?string alternateFullName): void
fullName ?string Optional When the party is a person, the party's full name.

Constraints: Maximum Length: 300
getFullName(): ?string setFullName(?string fullName): void

Example (as JSON)

{
  "prefix": "prefix4",
  "given_name": "given_name8",
  "surname": "surname8",
  "middle_name": "middle_name6",
  "suffix": "suffix6"
}