forked from LiveCarta/PayPal-PHP-Server-SDK
6b43a4225b
* Automated commit message * Automated commit message * Automated commit message * Automated commit message --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
|
|
# Supplementary Purchase Data
|
|
|
|
The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.
|
|
|
|
## Structure
|
|
|
|
`SupplementaryPurchaseData`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.{1,127}$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
|
| `noteToPayer` | `?string` | Optional | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.{1,255}$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"invoice_id": "invoice_id8",
|
|
"note_to_payer": "note_to_payer0"
|
|
}
|
|
```
|
|
|