Class DetailedRefund

Class DetailedRefund

A refund transaction. This is the resource that is returned on GET /refund

PayPal\Common\PayPalModel

Extended by

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

Extended by

PayPal\Api\Refund

Extended by

PayPal\Api\DetailedRefund

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/DetailedRefund.php

Methods summary

`public`	# `setCustom( string $custom )` free-form field for the use of clients free-form field for the use of clients Parameters `$custom` Returns $this
`public string`	# `getCustom( )` free-form field for the use of clients free-form field for the use of clients Returns string
`public`	# `setRefundToPayer( PayPal\Api\Currency $refund_to_payer )` Amount refunded to payer of the original transaction, in the current Refund call Amount refunded to payer of the original transaction, in the current Refund call Parameters `$refund_to_payer` Returns $this
`public PayPal\Api\Currency`	# `getRefundToPayer( )` Amount refunded to payer of the original transaction, in the current Refund call Amount refunded to payer of the original transaction, in the current Refund call Returns `PayPal\Api\Currency`
`public`	# `setRefundToExternalFunding( PayPal\Api\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 List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id Parameters `$refund_to_external_funding` Returns $this
`public PayPal\Api\ExternalFunding[]`	# `getRefundToExternalFunding( )` List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id Returns `PayPal\Api\ExternalFunding[]`
`public`	# `setRefundFromTransactionFee( PayPal\Api\Currency $refund_from_transaction_fee )` Transaction fee refunded to original recipient of payment. Transaction fee refunded to original recipient of payment. Parameters `$refund_from_transaction_fee` Returns $this
`public PayPal\Api\Currency`	# `getRefundFromTransactionFee( )` Transaction fee refunded to original recipient of payment. Transaction fee refunded to original recipient of payment. Returns `PayPal\Api\Currency`
`public`	# `setRefundFromReceivedAmount( PayPal\Api\Currency $refund_from_received_amount )` Amount subtracted from PayPal balance of the original recipient of payment, to make this refund. Amount subtracted from PayPal balance of the original recipient of payment, to make this refund. Parameters `$refund_from_received_amount` Returns $this
`public PayPal\Api\Currency`	# `getRefundFromReceivedAmount( )` Amount subtracted from PayPal balance of the original recipient of payment, to make this refund. Amount subtracted from PayPal balance of the original recipient of payment, to make this refund. Returns `PayPal\Api\Currency`
`public`	# `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. 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. Parameters `$total_refunded_amount` Returns $this
`public PayPal\Api\Currency`	# `getTotalRefundedAmount( )` 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. 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. Returns `PayPal\Api\Currency`

Methods inherited from PayPal\Api\Refund

get(), getAmount(), getCaptureId(), getCreateTime(), getDescription(), getId(), getInvoiceNumber(), getParentPayment(), getReason(), getReasonCode(), getSaleId(), getState(), getUpdateTime(), setAmount(), setCaptureId(), setCreateTime(), setDescription(), setId(), setInvoiceNumber(), setParentPayment(), setReason(), setReasonCode(), setSaleId(), setState(), setUpdateTime()

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel