1 | <?php |
||
8 | class Payment extends MoipResource |
||
9 | { |
||
10 | /** |
||
11 | * @const string |
||
12 | */ |
||
13 | const PATH = 'payments'; |
||
14 | |||
15 | /** |
||
16 | * @const string |
||
17 | */ |
||
18 | const MULTI_PAYMENTS_PATH = 'multipayments'; |
||
19 | |||
20 | /** |
||
21 | * Payment means. |
||
22 | * |
||
23 | * @const string |
||
24 | */ |
||
25 | const METHOD_CREDIT_CARD = 'CREDIT_CARD'; |
||
26 | |||
27 | /** |
||
28 | * Payment means. |
||
29 | * |
||
30 | * @const string |
||
31 | */ |
||
32 | const METHOD_BOLETO = 'BOLETO'; |
||
33 | |||
34 | /** |
||
35 | * Payment means. |
||
36 | * |
||
37 | * @const string |
||
38 | */ |
||
39 | const METHOD_ONLINE_DEBIT = 'ONLINE_DEBIT'; |
||
40 | |||
41 | /** |
||
42 | * Payment means. |
||
43 | * |
||
44 | * @const string |
||
45 | */ |
||
46 | const METHOD_WALLET = 'WALLET'; |
||
47 | |||
48 | /** |
||
49 | * Payment means. |
||
50 | * |
||
51 | * @const string |
||
52 | */ |
||
53 | const METHOD_ONLINE_BANK_DEBIT = 'ONLINE_BANK_DEBIT'; |
||
54 | |||
55 | /** |
||
56 | * @var \Moip\Resource\Orders |
||
57 | */ |
||
58 | private $order; |
||
59 | |||
60 | /** |
||
61 | * @var \Moip\Resource\Multiorders |
||
62 | */ |
||
63 | private $multiorder; |
||
64 | |||
65 | /** |
||
66 | * Initializes new instances. |
||
67 | */ |
||
68 | protected function initialize() |
||
69 | { |
||
70 | $this->data = new stdClass(); |
||
71 | $this->data->installmentCount = 1; |
||
72 | $this->data->fundingInstrument = new stdClass(); |
||
73 | } |
||
74 | |||
75 | /** |
||
76 | * Create a new payment in api MoIP. |
||
77 | * |
||
78 | * @return $this |
||
79 | */ |
||
80 | public function execute() |
||
81 | { |
||
82 | if ($this->order !== null) { |
||
83 | $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, Orders::PATH, $this->order->getId(), self::PATH); |
||
84 | } else { |
||
85 | $path = sprintf('/%s/%s/%s/%s', MoipResource::VERSION, Multiorders::PATH, $this->multiorder->getId(), |
||
86 | self::MULTI_PAYMENTS_PATH); |
||
87 | } |
||
88 | $response = $this->httpRequest($path, Requests::POST, $this); |
||
89 | |||
90 | return $this->populate($response); |
||
91 | } |
||
92 | |||
93 | /** |
||
94 | * Get an payment in MoIP. |
||
95 | * |
||
96 | * @param string $id_moip Id MoIP payment |
||
97 | * |
||
98 | * @return stdClass |
||
99 | */ |
||
100 | public function get($id_moip) |
||
104 | |||
105 | /** |
||
106 | * Get id MoIP payment. |
||
107 | * |
||
108 | * |
||
109 | * @return \Moip\Resource\Payment |
||
110 | */ |
||
111 | public function getId() |
||
115 | |||
116 | /** |
||
117 | * Mount payment structure. |
||
118 | * |
||
119 | * @param \stdClass $response |
||
120 | * |
||
121 | * @return Payment |
||
122 | */ |
||
123 | protected function populate(stdClass $response) |
||
124 | { |
||
125 | $payment = clone $this; |
||
126 | |||
127 | $payment->data->id = $this->getIfSet('id', $response); |
||
128 | $payment->data->status = $this->getIfSet('status', $response); |
||
129 | $payment->data->amount = new stdClass(); |
||
130 | $payment->data->amount->total = $this->getIfSet('total', $response->amount); |
||
131 | $payment->data->amount->currency = $this->getIfSet('currency', $response->amount); |
||
132 | $payment->data->installmentCount = $this->getIfSet('installmentCount', $response); |
||
133 | $payment->data->fundingInstrument = $this->getIfSet('fundingInstrument', $response); |
||
134 | $payment->data->fees = $this->getIfSet('fees', $response); |
||
135 | $payment->data->refunds = $this->getIfSet('refunds', $response); |
||
136 | $payment->data->_links = $this->getIfSet('_links', $response); |
||
137 | $payment->data->createdAt = $this->getIfSetDateTime('createdAt', $response); |
||
138 | $payment->data->updatedAt = $this->getIfSetDateTime('updatedAt', $response); |
||
139 | |||
140 | return $payment; |
||
141 | } |
||
142 | |||
143 | /** |
||
144 | * Refunds. |
||
145 | * |
||
146 | * @return Refund |
||
147 | */ |
||
148 | public function refunds() |
||
149 | { |
||
150 | $refund = new Refund($this->moip); |
||
151 | $refund->setPayment($this); |
||
152 | |||
153 | return $refund; |
||
154 | } |
||
155 | |||
156 | /** |
||
157 | * get creation time. |
||
158 | * |
||
159 | * @return \DateTime |
||
160 | */ |
||
161 | public function getCreatedAt() |
||
165 | |||
166 | /** |
||
167 | * Returns when the last update occurred. |
||
168 | * |
||
169 | * @return \DateTime |
||
170 | */ |
||
171 | public function getUpdatedAt() |
||
175 | |||
176 | /** |
||
177 | * Returns the funding instrument. |
||
178 | * |
||
179 | * @return stdClass |
||
180 | */ |
||
181 | public function getFundingInstrument() |
||
186 | |||
187 | /** |
||
188 | * Set means of payment. |
||
189 | * |
||
190 | * @param \stdClass $fundingInstrument |
||
191 | * |
||
192 | * @return $this |
||
193 | */ |
||
194 | public function setFundingInstrument(stdClass $fundingInstrument) |
||
195 | { |
||
196 | $this->data->fundingInstrument = $fundingInstrument; |
||
197 | |||
198 | return $this; |
||
199 | } |
||
200 | |||
201 | /** |
||
202 | * Set billet. |
||
203 | * |
||
204 | * @param \DateTime|string $expirationDate Expiration date of a billet. |
||
205 | * @param string $logoUri Logo of billet. |
||
206 | * @param array $instructionLines Instructions billet. |
||
207 | * |
||
208 | * @return $this |
||
209 | */ |
||
210 | public function setBoleto($expirationDate, $logoUri, array $instructionLines = []) |
||
211 | { |
||
212 | $keys = ['first', 'second', 'third']; |
||
213 | |||
214 | if (empty($instructionLines)) { |
||
215 | //Avoid warning in array_combine |
||
216 | $instructionLines = ['', '', '']; |
||
217 | } |
||
218 | |||
219 | if ($expirationDate instanceof \DateTime) { |
||
220 | $expirationDate = $expirationDate->format('Y-m-d'); |
||
221 | } |
||
222 | |||
223 | $this->data->fundingInstrument->method = self::METHOD_BOLETO; |
||
224 | $this->data->fundingInstrument->boleto = new stdClass(); |
||
225 | $this->data->fundingInstrument->boleto->expirationDate = $expirationDate; |
||
226 | $this->data->fundingInstrument->boleto->instructionLines = array_combine($keys, $instructionLines); |
||
227 | $this->data->fundingInstrument->boleto->logoUri = $logoUri; |
||
228 | |||
229 | return $this; |
||
230 | } |
||
231 | |||
232 | /** |
||
233 | * Set credit card holder. |
||
234 | * |
||
235 | * @param \Moip\Resource\Customer $holder |
||
236 | */ |
||
237 | private function setCreditCardHolder(Customer $holder) |
||
254 | |||
255 | /** |
||
256 | * Set credit cardHash. |
||
257 | * |
||
258 | * @param string $hash Credit card hash encripted using Moip.js |
||
259 | * @param \Moip\Resource\Customer $holder |
||
260 | * |
||
261 | * @return $this |
||
262 | */ |
||
263 | public function setCreditCardHash($hash, Customer $holder) |
||
272 | |||
273 | /** |
||
274 | * Set credit card |
||
275 | * Credit card used in a payment. |
||
276 | * The card when returned within a parent resource is presented in its minimum representation. |
||
277 | * |
||
278 | * @param int $expirationMonth Card expiration month |
||
279 | * @param int $expirationYear Year of card expiration. |
||
280 | * @param string $number Card number. |
||
281 | * @param int $cvc Card Security Code. |
||
282 | * @param \Moip\Resource\Customer $holder |
||
283 | * |
||
284 | * @return $this |
||
285 | */ |
||
286 | public function setCreditCard($expirationMonth, $expirationYear, $number, $cvc, Customer $holder) |
||
298 | |||
299 | /** |
||
300 | * Set installment count. |
||
301 | * |
||
302 | * @param int $installmentCount |
||
303 | * |
||
304 | * @return $this |
||
305 | */ |
||
306 | public function setInstallmentCount($installmentCount) |
||
312 | |||
313 | /** |
||
314 | * Set payment means made available by banks. |
||
315 | * |
||
316 | * @param string $bankNumber Bank number. Possible values: 001, 237, 341, 041. |
||
317 | * @param \DateTime|string $expirationDate Date of expiration debit. |
||
318 | * @param string $returnUri Return Uri. |
||
319 | * |
||
320 | * @return $this |
||
321 | */ |
||
322 | public function setOnlineBankDebit($bankNumber, $expirationDate, $returnUri) |
||
335 | |||
336 | /** |
||
337 | * Set Multiorders. |
||
338 | * |
||
339 | * @param \Moip\Resource\Multiorders $multiorder |
||
340 | */ |
||
341 | public function setMultiorder(Multiorders $multiorder) |
||
345 | |||
346 | /** |
||
347 | * Set order. |
||
348 | * |
||
349 | * @param \Moip\Resource\Orders $order |
||
350 | * |
||
351 | * @return $this |
||
352 | */ |
||
353 | public function setOrder(Orders $order) |
||
359 | } |
||
360 |