Property |
Type |
Description |
|
$Amount |
PayPal\CoreComponentTypes\BasicAmountType |
NOTE: If RefundType is Full, do not set Amount. |
|
$InvoiceID |
string |
Invoice number corresponding to transaction details for
tracking the refund of a payment. This parameter is passed
by the merchant or recipient while refunding the
transaction. This parameter does not affect the business
logic, it is persisted in the DB for transaction reference
Optional |
|
$Memo |
string |
Custom memo about the refund. Optional Character length and
limitations: 255 single-byte alphanumeric characters |
|
$MerchantStoreDetails |
PayPal\EBLBaseComponents\MerchantStoreDetailsType |
To pass the Merchant store informationOptional |
|
$MsgSubID |
string |
Unique id for each API request to prevent duplicate
payments. Optional Character length and limits: 38
single-byte characters maximum. |
|
$PayerID |
string |
Optional Character length and limitations: 127 single-byte
alphanumeric characters |
|
$RefundAdvice |
boolean |
Flag to indicate that the customer was already given store
credit for a given transaction. This will allow us to make
sure we do not double refund. Optional |
|
$RefundItemDetails |
PayPal\EBLBaseComponents\InvoiceItemType |
Information about the individual details of the items to be
refunded.Optional |
|
$RefundSource |
string |
The type of funding source for refund. Optional |
|
$RefundType |
string |
Type of refund you are making Required |
|
$RetryUntil |
|
The maximum time till which refund must be tried. Optional |
|
$TransactionID |
string |
Optional Character length and limitations: 17 single-byte
alphanumeric characters |
|