forked from LiveCarta/PayPal-PHP-Server-SDK
6da8b9b5b8
* Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com> Co-authored-by: Patrick Powers <patickpowers@hey.com>
1.1 KiB
1.1 KiB
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. 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. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^.{1,255}$ |
getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void |
Example (as JSON)
{
"invoice_id": "invoice_id8",
"note_to_payer": "note_to_payer0"
}