PHP Class PayPal\Api\DetailedRefund

A refund transaction. This is the resource that is returned on GET /refund
Inheritance: extends Refund
Exibir arquivo Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getCustom ( ) : string free-form field for the use of clients
getRefundFromReceivedAmount ( ) : PayPal\Api\Currency Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
getRefundFromTransactionFee ( ) : PayPal\Api\Currency Transaction fee refunded to original recipient of payment.
getRefundToExternalFunding ( ) : ExternalFunding[] List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id
getRefundToPayer ( ) : PayPal\Api\Currency Amount refunded to payer of the original transaction, in the current Refund call
getTotalRefundedAmount ( ) : PayPal\Api\Currency Total amount refunded so far from the original purchase. Say, for example, a buyer makes $100 purchase, the buyer was refunded $20 a week ago and is refunded $30 in this transaction. The gross refund amount is $30 (in this transaction). The total refunded amount is $50.
setCustom ( string $custom ) free-form field for the use of clients
setRefundFromReceivedAmount ( PayPal\Api\Currency $refund_from_received_amount ) Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
setRefundFromTransactionFee ( PayPal\Api\Currency $refund_from_transaction_fee ) Transaction fee refunded to original recipient of payment.
setRefundToExternalFunding ( ExternalFunding[] $refund_to_external_funding ) List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id
setRefundToPayer ( PayPal\Api\Currency $refund_to_payer ) Amount refunded to payer of the original transaction, in the current Refund call
setTotalRefundedAmount ( PayPal\Api\Currency $total_refunded_amount ) Total amount refunded so far from the original purchase. Say, for example, a buyer makes $100 purchase, the buyer was refunded $20 a week ago and is refunded $30 in this transaction. The gross refund amount is $30 (in this transaction). The total refunded amount is $50.

Method Details

getCustom() public method

free-form field for the use of clients
public getCustom ( ) : string
return string

getRefundFromReceivedAmount() public method

Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
public getRefundFromReceivedAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getRefundFromTransactionFee() public method

Transaction fee refunded to original recipient of payment.
public getRefundFromTransactionFee ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getRefundToExternalFunding() public method

List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id
public getRefundToExternalFunding ( ) : ExternalFunding[]
return ExternalFunding[]

getRefundToPayer() public method

Amount refunded to payer of the original transaction, in the current Refund call
public getRefundToPayer ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

getTotalRefundedAmount() public method

Total amount refunded so far from the original purchase. Say, for example, a buyer makes $100 purchase, the buyer was refunded $20 a week ago and is refunded $30 in this transaction. The gross refund amount is $30 (in this transaction). The total refunded amount is $50.
public getTotalRefundedAmount ( ) : PayPal\Api\Currency
return PayPal\Api\Currency

setCustom() public method

free-form field for the use of clients
public setCustom ( string $custom )
$custom string

setRefundFromReceivedAmount() public method

Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
public setRefundFromReceivedAmount ( PayPal\Api\Currency $refund_from_received_amount )
$refund_from_received_amount PayPal\Api\Currency

setRefundFromTransactionFee() public method

Transaction fee refunded to original recipient of payment.
public setRefundFromTransactionFee ( PayPal\Api\Currency $refund_from_transaction_fee )
$refund_from_transaction_fee PayPal\Api\Currency

setRefundToExternalFunding() public method

List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id
public setRefundToExternalFunding ( ExternalFunding[] $refund_to_external_funding )
$refund_to_external_funding ExternalFunding[]

setRefundToPayer() public method

Amount refunded to payer of the original transaction, in the current Refund call
public setRefundToPayer ( PayPal\Api\Currency $refund_to_payer )
$refund_to_payer PayPal\Api\Currency

setTotalRefundedAmount() public method

Total amount refunded so far from the original purchase. Say, for example, a buyer makes $100 purchase, the buyer was refunded $20 a week ago and is refunded $30 in this transaction. The gross refund amount is $30 (in this transaction). The total refunded amount is $50.
public setTotalRefundedAmount ( PayPal\Api\Currency $total_refunded_amount )
$total_refunded_amount PayPal\Api\Currency