1 | <?php |
||
10 | class BankAccount extends MoipResource |
||
11 | { |
||
12 | /** |
||
13 | * Path bank accounts API. |
||
14 | * |
||
15 | * @const string |
||
16 | */ |
||
17 | const PATH = 'bankaccounts'; |
||
18 | |||
19 | /** |
||
20 | * Path accounts API. |
||
21 | * |
||
22 | * @const string |
||
23 | */ |
||
24 | const PATH_ACCOUNT = 'accounts'; |
||
25 | |||
26 | /** |
||
27 | * Bank account type. |
||
28 | * |
||
29 | * @const string |
||
30 | */ |
||
31 | const CHECKING = 'CHECKING'; |
||
32 | |||
33 | /** |
||
34 | * Bank account type. |
||
35 | * |
||
36 | * @const string |
||
37 | */ |
||
38 | const SAVING = 'SAVING'; |
||
39 | |||
40 | /** |
||
41 | * Initialize a new instance. |
||
42 | */ |
||
43 | public function initialize() |
||
49 | |||
50 | /** |
||
51 | * Returns bank account id. |
||
52 | * |
||
53 | * @return stdClass |
||
54 | */ |
||
55 | public function getId() |
||
59 | |||
60 | /** |
||
61 | * Set bank account type. |
||
62 | * |
||
63 | * @param string $type Bank account type (CHECKING or SAVING). |
||
64 | * |
||
65 | * @return $this |
||
66 | */ |
||
67 | public function setType($type) |
||
73 | |||
74 | /** |
||
75 | * Returns bank account type. |
||
76 | * |
||
77 | * @return string |
||
78 | */ |
||
79 | public function getType() |
||
83 | |||
84 | /** |
||
85 | * Set bank number. |
||
86 | * |
||
87 | * @param string $bank_number Bank number. |
||
88 | * |
||
89 | * @return $this |
||
90 | */ |
||
91 | public function setBankNumber($bank_number) |
||
97 | |||
98 | /** |
||
99 | * Returns bank number. |
||
100 | * |
||
101 | * @return string |
||
102 | */ |
||
103 | public function getBankNumber() |
||
107 | |||
108 | /** |
||
109 | * Set bank account agency number. |
||
110 | * |
||
111 | * @param int $agency_number Bank account agency number. |
||
112 | * |
||
113 | * @return $this |
||
114 | */ |
||
115 | public function setAgencyNumber($agency_number) |
||
121 | |||
122 | /** |
||
123 | * Returns bank account agency number. |
||
124 | * |
||
125 | * @return int |
||
126 | */ |
||
127 | public function getAgencyNumber() |
||
131 | |||
132 | /** |
||
133 | * Set bank account agency check number. |
||
134 | * |
||
135 | * @param int $agency_check_number Bank account agency check number. |
||
136 | * |
||
137 | * @return $this |
||
138 | */ |
||
139 | public function setAgencyCheckNumber($agency_check_number) |
||
145 | |||
146 | /** |
||
147 | * Returns bank account agency check number. |
||
148 | * |
||
149 | * @return int |
||
150 | */ |
||
151 | public function getAgencyCheckNumber() |
||
155 | |||
156 | /** |
||
157 | * Set bank account number. |
||
158 | * |
||
159 | * @param int $account_number Bank account number. |
||
160 | * |
||
161 | * @return $this |
||
162 | */ |
||
163 | public function setAccountNumber($account_number) |
||
169 | |||
170 | /** |
||
171 | * Returns bank account number. |
||
172 | * |
||
173 | * @return int |
||
174 | */ |
||
175 | public function getAccountNumber() |
||
179 | |||
180 | /** |
||
181 | * Set bank account check number. |
||
182 | * |
||
183 | * @param int $account_check_number Bank account check number. |
||
184 | * |
||
185 | * @return $this |
||
186 | */ |
||
187 | public function setAccountCheckNumber($account_check_number) |
||
193 | |||
194 | /** |
||
195 | * Returns bank account check number. |
||
196 | * |
||
197 | * @return int |
||
198 | */ |
||
199 | public function getAccountCheckNumber() |
||
203 | |||
204 | /** |
||
205 | * Set holder. |
||
206 | * |
||
207 | * @param string $fullname Holder full name. |
||
208 | * @param string $number Document number. |
||
209 | * @param string $type Document type (CPF or CNPJ). |
||
210 | * |
||
211 | * @return $this |
||
212 | */ |
||
213 | public function setHolder($fullname, $number, $type) |
||
222 | |||
223 | /** |
||
224 | * Returns holder full name. |
||
225 | * |
||
226 | * @return string |
||
227 | */ |
||
228 | public function getFullname() |
||
232 | |||
233 | /** |
||
234 | * Get tax document type from customer. |
||
235 | * |
||
236 | * @return string Type of value: CPF and CNPJ |
||
237 | */ |
||
238 | public function getTaxDocumentType() |
||
242 | |||
243 | /** |
||
244 | * Get tax document number from customer. |
||
245 | * |
||
246 | * @return string Document Number. |
||
247 | */ |
||
248 | public function getTaxDocumentNumber() |
||
252 | |||
253 | /** |
||
254 | * Get a bank account. |
||
255 | * |
||
256 | * @param string $bank_account_id Bank account id. |
||
257 | * |
||
258 | * @return stdClass |
||
259 | */ |
||
260 | public function get($bank_account_id) |
||
264 | |||
265 | /** |
||
266 | * Create a new BankAccount List instance. |
||
267 | * |
||
268 | * @param string Account id. |
||
269 | * |
||
270 | * @return \Moip\Resource\BankAccountList |
||
271 | */ |
||
272 | public function getList($account_id) |
||
278 | |||
279 | /** |
||
280 | * Create a new bank account. |
||
281 | * |
||
282 | * @param string Account id. |
||
283 | * |
||
284 | * @return stdClass |
||
285 | */ |
||
286 | public function create($account_id) |
||
290 | |||
291 | /** |
||
292 | * Update a bank account. |
||
293 | * |
||
294 | * @param string|null $bank_account_id Bank account id. |
||
295 | * |
||
296 | * @return stdClass |
||
297 | */ |
||
298 | public function update($bank_account_id = null) |
||
304 | |||
305 | /** |
||
306 | * Delete a bank account. |
||
307 | * |
||
308 | * @param string $bank_account_id Bank account id. |
||
309 | * |
||
310 | * @return mixed |
||
311 | */ |
||
312 | public function delete($bank_account_id) |
||
316 | |||
317 | /** |
||
318 | * Mount the bank account structure. |
||
319 | * |
||
320 | * @param stdClass $response |
||
321 | * |
||
322 | * @return \Moip\Resource\BankAccount |
||
323 | */ |
||
324 | protected function populate(stdClass $response) |
||
351 | } |
||
352 |