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>
69 lines
3.1 KiB
Markdown
69 lines
3.1 KiB
Markdown
|
|
# Capture Request
|
|
|
|
## Structure
|
|
|
|
`CaptureRequest`
|
|
|
|
## 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 |
|
|
| `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 |
|
|
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
|
| `paymentInstruction` | [`?CapturePaymentInstruction`](../../doc/models/capture-payment-instruction.md) | Optional | Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | getPaymentInstruction(): ?CapturePaymentInstruction | setPaymentInstruction(?CapturePaymentInstruction paymentInstruction): void |
|
|
| `softDescriptor` | `?string` | Optional | The payment descriptor on the payer's account statement.<br>**Constraints**: *Maximum Length*: `22` | getSoftDescriptor(): ?string | setSoftDescriptor(?string softDescriptor): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"final_capture": false,
|
|
"invoice_id": "invoice_id4",
|
|
"note_to_payer": "note_to_payer6",
|
|
"amount": {
|
|
"currency_code": "currency_code6",
|
|
"value": "value0"
|
|
},
|
|
"payment_instruction": {
|
|
"platform_fees": [
|
|
{
|
|
"amount": {
|
|
"currency_code": "currency_code6",
|
|
"value": "value0"
|
|
},
|
|
"payee": {
|
|
"email_address": "email_address4",
|
|
"merchant_id": "merchant_id6"
|
|
}
|
|
},
|
|
{
|
|
"amount": {
|
|
"currency_code": "currency_code6",
|
|
"value": "value0"
|
|
},
|
|
"payee": {
|
|
"email_address": "email_address4",
|
|
"merchant_id": "merchant_id6"
|
|
}
|
|
},
|
|
{
|
|
"amount": {
|
|
"currency_code": "currency_code6",
|
|
"value": "value0"
|
|
},
|
|
"payee": {
|
|
"email_address": "email_address4",
|
|
"merchant_id": "merchant_id6"
|
|
}
|
|
}
|
|
],
|
|
"disbursement_mode": "INSTANT",
|
|
"payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0"
|
|
}
|
|
}
|
|
```
|
|
|