PayPalApiBankAccount

Class BankAccount.

Defined (1)

The class is defined in the following location(s).

/classes/lib/PayPal/Api/BankAccount.php  
  1. class BankAccount extends PayPalModel 
  2. /** 
  3. * ID of the bank account being saved for later use. 
  4. * @deprecated Not publicly available 
  5. * @param string $id 
  6. * @return $this 
  7. */ 
  8. public function setId($id) 
  9. $this->id = $id; 
  10. return $this; 
  11.  
  12. /** 
  13. * ID of the bank account being saved for later use. 
  14. * @deprecated Not publicly available 
  15. * @return string 
  16. */ 
  17. public function getId() 
  18. return $this->id; 
  19.  
  20. /** 
  21. * Account number in either IBAN (max length 34) or BBAN (max length 17) format. 
  22. * @param string $account_number 
  23. * @return $this 
  24. */ 
  25. public function setAccountNumber($account_number) 
  26. $this->account_number = $account_number; 
  27. return $this; 
  28.  
  29. /** 
  30. * Account number in either IBAN (max length 34) or BBAN (max length 17) format. 
  31. * @return string 
  32. */ 
  33. public function getAccountNumber() 
  34. return $this->account_number; 
  35.  
  36. /** 
  37. * Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. 
  38. * Valid Values: ["BBAN", "IBAN"] 
  39. * @param string $account_number_type 
  40. * @return $this 
  41. */ 
  42. public function setAccountNumberType($account_number_type) 
  43. $this->account_number_type = $account_number_type; 
  44. return $this; 
  45.  
  46. /** 
  47. * Type of the bank account number (International or Basic Bank Account Number). For more information refer to http://en.wikipedia.org/wiki/International_Bank_Account_Number. 
  48. * @return string 
  49. */ 
  50. public function getAccountNumberType() 
  51. return $this->account_number_type; 
  52.  
  53. /** 
  54. * Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. 
  55. * @param string $routing_number 
  56. * @return $this 
  57. */ 
  58. public function setRoutingNumber($routing_number) 
  59. $this->routing_number = $routing_number; 
  60. return $this; 
  61.  
  62. /** 
  63. * Routing transit number (aka Bank Code) of the bank (typically for domestic use only - for international use, IBAN includes bank code). For more information refer to http://en.wikipedia.org/wiki/Bank_code. 
  64. * @return string 
  65. */ 
  66. public function getRoutingNumber() 
  67. return $this->routing_number; 
  68.  
  69. /** 
  70. * Type of the bank account. 
  71. * Valid Values: ["CHECKING", "SAVINGS"] 
  72. * @param string $account_type 
  73. * @return $this 
  74. */ 
  75. public function setAccountType($account_type) 
  76. $this->account_type = $account_type; 
  77. return $this; 
  78.  
  79. /** 
  80. * Type of the bank account. 
  81. * @return string 
  82. */ 
  83. public function getAccountType() 
  84. return $this->account_type; 
  85.  
  86. /** 
  87. * A customer designated name. 
  88. * @param string $account_name 
  89. * @return $this 
  90. */ 
  91. public function setAccountName($account_name) 
  92. $this->account_name = $account_name; 
  93. return $this; 
  94.  
  95. /** 
  96. * A customer designated name. 
  97. * @return string 
  98. */ 
  99. public function getAccountName() 
  100. return $this->account_name; 
  101.  
  102. /** 
  103. * Type of the check when this information was obtained through a check by the facilitator or merchant. 
  104. * Valid Values: ["PERSONAL", "COMPANY"] 
  105. * @param string $check_type 
  106. * @return $this 
  107. */ 
  108. public function setCheckType($check_type) 
  109. $this->check_type = $check_type; 
  110. return $this; 
  111.  
  112. /** 
  113. * Type of the check when this information was obtained through a check by the facilitator or merchant. 
  114. * @return string 
  115. */ 
  116. public function getCheckType() 
  117. return $this->check_type; 
  118.  
  119. /** 
  120. * How the check was obtained from the customer, if check was the source of the information provided. 
  121. * Valid Values: ["CCD", "PPD", "TEL", "POP", "ARC", "RCK", "WEB"] 
  122. * @param string $auth_type 
  123. * @return $this 
  124. */ 
  125. public function setAuthType($auth_type) 
  126. $this->auth_type = $auth_type; 
  127. return $this; 
  128.  
  129. /** 
  130. * How the check was obtained from the customer, if check was the source of the information provided. 
  131. * @return string 
  132. */ 
  133. public function getAuthType() 
  134. return $this->auth_type; 
  135.  
  136. /** 
  137. * Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. 
  138. * @param string $auth_capture_timestamp 
  139. * @return $this 
  140. */ 
  141. public function setAuthCaptureTimestamp($auth_capture_timestamp) 
  142. $this->auth_capture_timestamp = $auth_capture_timestamp; 
  143. return $this; 
  144.  
  145. /** 
  146. * Time at which the authorization (or check) was captured. Use this field if the user authorization needs to be captured due to any privacy requirements. 
  147. * @return string 
  148. */ 
  149. public function getAuthCaptureTimestamp() 
  150. return $this->auth_capture_timestamp; 
  151.  
  152. /** 
  153. * Name of the bank. 
  154. * @param string $bank_name 
  155. * @return $this 
  156. */ 
  157. public function setBankName($bank_name) 
  158. $this->bank_name = $bank_name; 
  159. return $this; 
  160.  
  161. /** 
  162. * Name of the bank. 
  163. * @return string 
  164. */ 
  165. public function getBankName() 
  166. return $this->bank_name; 
  167.  
  168. /** 
  169. * 2 letter country code of the Bank. 
  170. * @param string $country_code 
  171. * @return $this 
  172. */ 
  173. public function setCountryCode($country_code) 
  174. $this->country_code = $country_code; 
  175. return $this; 
  176.  
  177. /** 
  178. * 2 letter country code of the Bank. 
  179. * @return string 
  180. */ 
  181. public function getCountryCode() 
  182. return $this->country_code; 
  183.  
  184. /** 
  185. * Account holder's first name. 
  186. * @param string $first_name 
  187. * @return $this 
  188. */ 
  189. public function setFirstName($first_name) 
  190. $this->first_name = $first_name; 
  191. return $this; 
  192.  
  193. /** 
  194. * Account holder's first name. 
  195. * @return string 
  196. */ 
  197. public function getFirstName() 
  198. return $this->first_name; 
  199.  
  200. /** 
  201. * Account holder's last name. 
  202. * @param string $last_name 
  203. * @return $this 
  204. */ 
  205. public function setLastName($last_name) 
  206. $this->last_name = $last_name; 
  207. return $this; 
  208.  
  209. /** 
  210. * Account holder's last name. 
  211. * @return string 
  212. */ 
  213. public function getLastName() 
  214. return $this->last_name; 
  215.  
  216. /** 
  217. * Birth date of the bank account holder. 
  218. * @param string $birth_date 
  219. * @return $this 
  220. */ 
  221. public function setBirthDate($birth_date) 
  222. $this->birth_date = $birth_date; 
  223. return $this; 
  224.  
  225. /** 
  226. * Birth date of the bank account holder. 
  227. * @return string 
  228. */ 
  229. public function getBirthDate() 
  230. return $this->birth_date; 
  231.  
  232. /** 
  233. * Billing address. 
  234. * @param \PayPal\Api\Address $billing_address 
  235. * @return $this 
  236. */ 
  237. public function setBillingAddress($billing_address) 
  238. $this->billing_address = $billing_address; 
  239. return $this; 
  240.  
  241. /** 
  242. * Billing address. 
  243. * @return \PayPal\Api\Address 
  244. */ 
  245. public function getBillingAddress() 
  246. return $this->billing_address; 
  247.  
  248. /** 
  249. * State of this funding instrument. 
  250. * Valid Values: ["ACTIVE", "INACTIVE", "DELETED"] 
  251. * @param string $state 
  252. * @return $this 
  253. */ 
  254. public function setState($state) 
  255. $this->state = $state; 
  256. return $this; 
  257.  
  258. /** 
  259. * State of this funding instrument. 
  260. * @return string 
  261. */ 
  262. public function getState() 
  263. return $this->state; 
  264.  
  265. /** 
  266. * Confirmation status of a bank account. 
  267. * Valid Values: ["UNCONFIRMED", "CONFIRMED"] 
  268. * @param string $confirmation_status 
  269. * @return $this 
  270. */ 
  271. public function setConfirmationStatus($confirmation_status) 
  272. $this->confirmation_status = $confirmation_status; 
  273. return $this; 
  274.  
  275. /** 
  276. * Confirmation status of a bank account. 
  277. * @return string 
  278. */ 
  279. public function getConfirmationStatus() 
  280. return $this->confirmation_status; 
  281.  
  282. /** 
  283. * [DEPRECATED] Use external_customer_id instead. 
  284. * @param string $payer_id 
  285. * @return $this 
  286. */ 
  287. public function setPayerId($payer_id) 
  288. $this->payer_id = $payer_id; 
  289. return $this; 
  290.  
  291. /** 
  292. * @deprecated [DEPRECATED] Use external_customer_id instead. 
  293. * @return string 
  294. */ 
  295. public function getPayerId() 
  296. return $this->payer_id; 
  297.  
  298. /** 
  299. * A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. 
  300. * @param string $external_customer_id 
  301. * @return $this 
  302. */ 
  303. public function setExternalCustomerId($external_customer_id) 
  304. $this->external_customer_id = $external_customer_id; 
  305. return $this; 
  306.  
  307. /** 
  308. * A unique identifier of the customer to whom this bank account belongs to. Generated and provided by the facilitator. This is required when creating or using a stored funding instrument in vault. 
  309. * @return string 
  310. */ 
  311. public function getExternalCustomerId() 
  312. return $this->external_customer_id; 
  313.  
  314. /** 
  315. * A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchnt. 
  316. * @param string $merchant_id 
  317. * @return $this 
  318. */ 
  319. public function setMerchantId($merchant_id) 
  320. $this->merchant_id = $merchant_id; 
  321. return $this; 
  322.  
  323. /** 
  324. * A unique identifier of the merchant for which this bank account has been stored for. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchnt. 
  325. * @return string 
  326. */ 
  327. public function getMerchantId() 
  328. return $this->merchant_id; 
  329.  
  330. /** 
  331. * Time the resource was created. 
  332. * @param string $create_time 
  333. * @return $this 
  334. */ 
  335. public function setCreateTime($create_time) 
  336. $this->create_time = $create_time; 
  337. return $this; 
  338.  
  339. /** 
  340. * Time the resource was created. 
  341. * @return string 
  342. */ 
  343. public function getCreateTime() 
  344. return $this->create_time; 
  345.  
  346. /** 
  347. * Time the resource was last updated. 
  348. * @param string $update_time 
  349. * @return $this 
  350. */ 
  351. public function setUpdateTime($update_time) 
  352. $this->update_time = $update_time; 
  353. return $this; 
  354.  
  355. /** 
  356. * Time the resource was last updated. 
  357. * @return string 
  358. */ 
  359. public function getUpdateTime() 
  360. return $this->update_time; 
  361.  
  362. /** 
  363. * Date/Time until this resource can be used to fund a payment. 
  364. * @param string $valid_until 
  365. * @return $this 
  366. */ 
  367. public function setValidUntil($valid_until) 
  368. $this->valid_until = $valid_until; 
  369. return $this; 
  370.  
  371. /** 
  372. * Date/Time until this resource can be used to fund a payment. 
  373. * @return string 
  374. */ 
  375. public function getValidUntil() 
  376. return $this->valid_until; 
  377.  
  378. /** 
  379. * Sets Links 
  380. * @param \PayPal\Api\Links[] $links 
  381. * @return $this 
  382. */ 
  383. public function setLinks($links) 
  384. $this->links = $links; 
  385. return $this; 
  386.  
  387. /** 
  388. * Gets Links 
  389. * @return \PayPal\Api\Links[] 
  390. */ 
  391. public function getLinks() 
  392. return $this->links; 
  393.  
  394. /** 
  395. * Append Links to the list. 
  396. * @param \PayPal\Api\Links $links 
  397. * @return $this 
  398. */ 
  399. public function addLink($links) 
  400. if (!$this->getLinks()) { 
  401. return $this->setLinks(array($links)); 
  402. } else { 
  403. return $this->setLinks( 
  404. array_merge($this->getLinks(), array($links)) 
  405. ); 
  406.  
  407. /** 
  408. * Remove Links from the list. 
  409. * @param \PayPal\Api\Links $links 
  410. * @return $this 
  411. */ 
  412. public function removeLink($links) 
  413. return $this->setLinks( 
  414. array_diff($this->getLinks(), array($links)) 
  415. ); 
  416.