PayPalApiPayoutBatchHeader

Class PayoutBatchHeader.

Defined (1)

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

/classes/lib/PayPal/Api/PayoutBatchHeader.php  
  1. class PayoutBatchHeader extends PayPalModel 
  2. /** 
  3. * An ID for the batch payout. Generated by PayPal. 30 characters max. 
  4. * @param string $payout_batch_id 
  5. *  
  6. * @return $this 
  7. */ 
  8. public function setPayoutBatchId($payout_batch_id) 
  9. $this->payout_batch_id = $payout_batch_id; 
  10. return $this; 
  11.  
  12. /** 
  13. * An ID for the batch payout. Generated by PayPal. 30 characters max. 
  14. * @return string 
  15. */ 
  16. public function getPayoutBatchId() 
  17. return $this->payout_batch_id; 
  18.  
  19. /** 
  20. * Generated batch status. 
  21. * @param string $batch_status 
  22. *  
  23. * @return $this 
  24. */ 
  25. public function setBatchStatus($batch_status) 
  26. $this->batch_status = $batch_status; 
  27. return $this; 
  28.  
  29. /** 
  30. * Generated batch status. 
  31. * @return string 
  32. */ 
  33. public function getBatchStatus() 
  34. return $this->batch_status; 
  35.  
  36. /** 
  37. * The time the batch entered processing. 
  38. * @param string $time_created 
  39. *  
  40. * @return $this 
  41. */ 
  42. public function setTimeCreated($time_created) 
  43. $this->time_created = $time_created; 
  44. return $this; 
  45.  
  46. /** 
  47. * The time the batch entered processing. 
  48. * @return string 
  49. */ 
  50. public function getTimeCreated() 
  51. return $this->time_created; 
  52.  
  53. /** 
  54. * The time that processing for the batch was completed. 
  55. * @param string $time_completed 
  56. *  
  57. * @return $this 
  58. */ 
  59. public function setTimeCompleted($time_completed) 
  60. $this->time_completed = $time_completed; 
  61. return $this; 
  62.  
  63. /** 
  64. * The time that processing for the batch was completed. 
  65. * @return string 
  66. */ 
  67. public function getTimeCompleted() 
  68. return $this->time_completed; 
  69.  
  70. /** 
  71. * The original batch header as provided by the payment sender. 
  72. * @param \PayPal\Api\PayoutSenderBatchHeader $sender_batch_header 
  73. *  
  74. * @return $this 
  75. */ 
  76. public function setSenderBatchHeader($sender_batch_header) 
  77. $this->sender_batch_header = $sender_batch_header; 
  78. return $this; 
  79.  
  80. /** 
  81. * The original batch header as provided by the payment sender. 
  82. * @return \PayPal\Api\PayoutSenderBatchHeader 
  83. */ 
  84. public function getSenderBatchHeader() 
  85. return $this->sender_batch_header; 
  86.  
  87. /** 
  88. * Total amount, in U.S. dollars, requested for the applicable payouts. 
  89. * @param \PayPal\Api\Currency $amount 
  90. *  
  91. * @return $this 
  92. */ 
  93. public function setAmount($amount) 
  94. $this->amount = $amount; 
  95. return $this; 
  96.  
  97. /** 
  98. * Total amount, in U.S. dollars, requested for the applicable payouts. 
  99. * @return \PayPal\Api\Currency 
  100. */ 
  101. public function getAmount() 
  102. return $this->amount; 
  103.  
  104. /** 
  105. * Total estimate in U.S. dollars for the applicable payouts fees. 
  106. * @param \PayPal\Api\Currency $fees 
  107. *  
  108. * @return $this 
  109. */ 
  110. public function setFees($fees) 
  111. $this->fees = $fees; 
  112. return $this; 
  113.  
  114. /** 
  115. * Total estimate in U.S. dollars for the applicable payouts fees. 
  116. * @return \PayPal\Api\Currency 
  117. */ 
  118. public function getFees() 
  119. return $this->fees; 
  120.  
  121. /** 
  122. * Sets Errors 
  123. * @param \PayPal\Api\Error $errors 
  124. *  
  125. * @return $this 
  126. */ 
  127. public function setErrors($errors) 
  128. $this->errors = $errors; 
  129. return $this; 
  130.  
  131. /** 
  132. * Gets Errors 
  133. * @return \PayPal\Api\Error 
  134. */ 
  135. public function getErrors() 
  136. return $this->errors; 
  137.  
  138. /** 
  139. * Sets Links 
  140. * @param \PayPal\Api\Links[] $links 
  141. *  
  142. * @return $this 
  143. */ 
  144. public function setLinks($links) 
  145. $this->links = $links; 
  146. return $this; 
  147.  
  148. /** 
  149. * Gets Links 
  150. * @return \PayPal\Api\Links[] 
  151. */ 
  152. public function getLinks() 
  153. return $this->links; 
  154.  
  155. /** 
  156. * Append Links to the list. 
  157. * @param \PayPal\Api\Links $links 
  158. * @return $this 
  159. */ 
  160. public function addLink($links) 
  161. if (!$this->getLinks()) { 
  162. return $this->setLinks(array($links)); 
  163. } else { 
  164. return $this->setLinks( 
  165. array_merge($this->getLinks(), array($links)) 
  166. ); 
  167.  
  168. /** 
  169. * Remove Links from the list. 
  170. * @param \PayPal\Api\Links $links 
  171. * @return $this 
  172. */ 
  173. public function removeLink($links) 
  174. return $this->setLinks( 
  175. array_diff($this->getLinks(), array($links)) 
  176. ); 
  177.