lxbfYeaa/PayPal-PHP-Server-SDK
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-Server-SDK
Code Pull Requests Activity

Automated commit message

Browse Source
This commit is contained in:
PayPalServerSDKs
2024-09-04 15:55:32 +00:00
parent c9cb1ad04a
commit f6cd8b4d4f
732 changed files with 73611 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
doc/models/refund-request.md Normal file
View File

@@ -0,0 +1,55 @@
# Refund Request
Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial refund, include an <code>amount</code> object in the request body.
## Structure
`RefundRequest`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getCustomId(): ?string | setCustomId(?string customId): void |
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice ID for this order. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
| `noteToPayer` | `?string` | Optional | The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.*$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): void |
| `paymentInstruction` | [`?RefundPaymentInstruction`](../../doc/models/refund-payment-instruction.md) | Optional | Any additional payments instructions during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability. | getPaymentInstruction(): ?RefundPaymentInstruction | setPaymentInstruction(?RefundPaymentInstruction paymentInstruction): void |
## Example (as JSON)
```json
{
"amount": {
"currency_code": "currency_code6",
"value": "value0"
},
"custom_id": "custom_id6",
"invoice_id": "invoice_id8",
"note_to_payer": "note_to_payer0",
"payment_instruction": {
"platform_fees": [
{
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
},
{
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
},
{
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
}
]
}
}
```