forked from LiveCarta/PayPal-PHP-Server-SDK
34 lines
2.1 KiB
Markdown
34 lines
2.1 KiB
Markdown
|
|
# 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.<br><br>**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.<br><br>**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.<br><br>**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.<br><br>**Constraints**: *Maximum Length*: `140` | getMiddleName(): ?string | setMiddleName(?string middleName): void |
|
|
| `suffix` | `?string` | Optional | The suffix for the party's name.<br><br>**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.<br><br>**Constraints**: *Maximum Length*: `300` | getAlternateFullName(): ?string | setAlternateFullName(?string alternateFullName): void |
|
|
| `fullName` | `?string` | Optional | When the party is a person, the party's full name.<br><br>**Constraints**: *Maximum Length*: `300` | getFullName(): ?string | setFullName(?string fullName): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"prefix": "prefix4",
|
|
"given_name": "given_name8",
|
|
"surname": "surname8",
|
|
"middle_name": "middle_name6",
|
|
"suffix": "suffix6"
|
|
}
|
|
```
|
|
|