1 <?php
2
3 namespace PayPal\Api;
4
5
6 /**
7 * Class DetailedRefund
8 *
9 * A refund transaction. This is the resource that is returned on GET /refund
10 *
11 * @package PayPal\Api
12 *
13 * @property string custom
14 * @property \PayPal\Api\Currency refund_to_payer
15 * @property \PayPal\Api\ExternalFunding[] refund_to_external_funding
16 * @property \PayPal\Api\Currency refund_from_transaction_fee
17 * @property \PayPal\Api\Currency refund_from_received_amount
18 * @property \PayPal\Api\Currency total_refunded_amount
19 */
20 class DetailedRefund extends Refund
21 {
22 /**
23 * free-form field for the use of clients
24 *
25 * @param string $custom
26 *
27 * @return $this
28 */
29 public function setCustom($custom)
30 {
31 $this->custom = $custom;
32 return $this;
33 }
34
35 /**
36 * free-form field for the use of clients
37 *
38 * @return string
39 */
40 public function getCustom()
41 {
42 return $this->custom;
43 }
44
45 /**
46 * Amount refunded to payer of the original transaction, in the current Refund call
47 *
48 * @param \PayPal\Api\Currency $refund_to_payer
49 *
50 * @return $this
51 */
52 public function setRefundToPayer($refund_to_payer)
53 {
54 $this->refund_to_payer = $refund_to_payer;
55 return $this;
56 }
57
58 /**
59 * Amount refunded to payer of the original transaction, in the current Refund call
60 *
61 * @return \PayPal\Api\Currency
62 */
63 public function getRefundToPayer()
64 {
65 return $this->refund_to_payer;
66 }
67
68 /**
69 * List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id
70 *
71 * @param \PayPal\Api\ExternalFunding[] $refund_to_external_funding
72 *
73 * @return $this
74 */
75 public function setRefundToExternalFunding($refund_to_external_funding)
76 {
77 $this->refund_to_external_funding = $refund_to_external_funding;
78 return $this;
79 }
80
81 /**
82 * List of external funding that were refunded by the Refund call. Each external_funding unit should have a unique reference_id
83 *
84 * @return \PayPal\Api\ExternalFunding[]
85 */
86 public function getRefundToExternalFunding()
87 {
88 return $this->refund_to_external_funding;
89 }
90
91 /**
92 * Transaction fee refunded to original recipient of payment.
93 *
94 * @param \PayPal\Api\Currency $refund_from_transaction_fee
95 *
96 * @return $this
97 */
98 public function setRefundFromTransactionFee($refund_from_transaction_fee)
99 {
100 $this->refund_from_transaction_fee = $refund_from_transaction_fee;
101 return $this;
102 }
103
104 /**
105 * Transaction fee refunded to original recipient of payment.
106 *
107 * @return \PayPal\Api\Currency
108 */
109 public function getRefundFromTransactionFee()
110 {
111 return $this->refund_from_transaction_fee;
112 }
113
114 /**
115 * Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
116 *
117 * @param \PayPal\Api\Currency $refund_from_received_amount
118 *
119 * @return $this
120 */
121 public function setRefundFromReceivedAmount($refund_from_received_amount)
122 {
123 $this->refund_from_received_amount = $refund_from_received_amount;
124 return $this;
125 }
126
127 /**
128 * Amount subtracted from PayPal balance of the original recipient of payment, to make this refund.
129 *
130 * @return \PayPal\Api\Currency
131 */
132 public function getRefundFromReceivedAmount()
133 {
134 return $this->refund_from_received_amount;
135 }
136
137 /**
138 * 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.
139 *
140 * @param \PayPal\Api\Currency $total_refunded_amount
141 *
142 * @return $this
143 */
144 public function setTotalRefundedAmount($total_refunded_amount)
145 {
146 $this->total_refunded_amount = $total_refunded_amount;
147 return $this;
148 }
149
150 /**
151 * 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.
152 *
153 * @return \PayPal\Api\Currency
154 */
155 public function getTotalRefundedAmount()
156 {
157 return $this->total_refunded_amount;
158 }
159
160 }
161