PHP Class PayPal\PayPalAPI\RefundTransactionRequestType

Optional Character length and limitations: 17 single-byte alphanumeric characters
Inheritance: extends PayPal\EBLBaseComponents\AbstractRequestType
Show file Open project: paypal/merchant-sdk-php Class Usage Examples

Public Properties

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

Property Details

$Amount public property

NOTE: If RefundType is Full, do not set Amount.
public BasicAmountType,PayPal\CoreComponentTypes $Amount
return PayPal\CoreComponentTypes\BasicAmountType

$InvoiceID public property

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
public string $InvoiceID
return string

$Memo public property

Custom memo about the refund. Optional Character length and limitations: 255 single-byte alphanumeric characters
public string $Memo
return string

$MerchantStoreDetails public property

To pass the Merchant store informationOptional
public MerchantStoreDetailsType,PayPal\EBLBaseComponents $MerchantStoreDetails
return PayPal\EBLBaseComponents\MerchantStoreDetailsType

$MsgSubID public property

Unique id for each API request to prevent duplicate payments. Optional Character length and limits: 38 single-byte characters maximum.
public string $MsgSubID
return string

$PayerID public property

Optional Character length and limitations: 127 single-byte alphanumeric characters
public string $PayerID
return string

$RefundAdvice public property

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
public bool $RefundAdvice
return boolean

$RefundItemDetails public property

Information about the individual details of the items to be refunded.Optional
public InvoiceItemType,PayPal\EBLBaseComponents $RefundItemDetails
return PayPal\EBLBaseComponents\InvoiceItemType

$RefundSource public property

The type of funding source for refund. Optional
public string $RefundSource
return string

$RefundType public property

Type of refund you are making Required
public string $RefundType
return string

$RetryUntil public property

The maximum time till which refund must be tried. Optional
public $RetryUntil

$TransactionID public property

Optional Character length and limitations: 17 single-byte alphanumeric characters
public string $TransactionID
return string