1 <?php
2
3 namespace PayPal\Api;
4
5 use PayPal\Common\PayPalModel;
6
7 /**
8 * Class PayoutSenderBatchHeader
9 *
10 * The sender-provided batch header for a batch payout request.
11 *
12 * @package PayPal\Api
13 *
14 * @property string sender_batch_id
15 * @property string email_subject
16 * @property string recipient_type
17 * @property string batch_status
18 */
19 class PayoutSenderBatchHeader extends PayPalModel
20 {
21 /**
22 * A sender-specified ID number. Tracks the batch payout in an accounting system.<blockquote><strong>Note:</strong> PayPal prevents duplicate batches from being processed. If you specify a `sender_batch_id` that was used in the last 30 days, the API rejects the request and returns an error message that indicates the duplicate `sender_batch_id` and includes a HATEOAS link to the original batch payout with the same `sender_batch_id`. If you receive a HTTP `5nn` status code, you can safely retry the request with the same `sender_batch_id`. In any case, the API completes a payment only once for a specific `sender_batch_id` that is used within 30 days.</blockquote>
23 *
24 * @param string $sender_batch_id
25 *
26 * @return $this
27 */
28 public function setSenderBatchId($sender_batch_id)
29 {
30 $this->sender_batch_id = $sender_batch_id;
31 return $this;
32 }
33
34 /**
35 * A sender-specified ID number. Tracks the batch payout in an accounting system.<blockquote><strong>Note:</strong> PayPal prevents duplicate batches from being processed. If you specify a `sender_batch_id` that was used in the last 30 days, the API rejects the request and returns an error message that indicates the duplicate `sender_batch_id` and includes a HATEOAS link to the original batch payout with the same `sender_batch_id`. If you receive a HTTP `5nn` status code, you can safely retry the request with the same `sender_batch_id`. In any case, the API completes a payment only once for a specific `sender_batch_id` that is used within 30 days.</blockquote>
36 *
37 * @return string
38 */
39 public function getSenderBatchId()
40 {
41 return $this->sender_batch_id;
42 }
43
44 /**
45 * The subject line text for the email that PayPal sends when a payout item completes. The subject line is the same for all recipients. Value is an alphanumeric string with a maximum length of 255 single-byte characters.
46 *
47 * @param string $email_subject
48 *
49 * @return $this
50 */
51 public function setEmailSubject($email_subject)
52 {
53 $this->email_subject = $email_subject;
54 return $this;
55 }
56
57 /**
58 * The subject line text for the email that PayPal sends when a payout item completes. The subject line is the same for all recipients. Value is an alphanumeric string with a maximum length of 255 single-byte characters.
59 *
60 * @return string
61 */
62 public function getEmailSubject()
63 {
64 return $this->email_subject;
65 }
66
67 /**
68 * The type of ID that identifies the payment receiver. Value is:<ul><code>EMAIL</code>. Unencrypted email. Value is a string of up to 127 single-byte characters.</li><li><code>PHONE</code>. Unencrypted phone number.<blockquote><strong>Note:</strong> The PayPal sandbox does not support the <code>PHONE</code> recipient type.</blockquote></li><li><code>PAYPAL_ID</code>. Encrypted PayPal account number.</li></ul>If the <code>sender_batch_header</code> includes the <code>recipient_type</code> attribute, any payout item without its own <code>recipient_type</code> attribute uses the <code>recipient_type</code> value from <code>sender_batch_header</code>. If the <code>sender_batch_header</code> omits the <code>recipient_type</code> attribute, each payout item must include its own <code>recipient_type</code> value.
69 *
70 * @param string $recipient_type
71 *
72 * @return $this
73 */
74 public function setRecipientType($recipient_type)
75 {
76 $this->recipient_type = $recipient_type;
77 return $this;
78 }
79
80 /**
81 * The type of ID that identifies the payment receiver. Value is:<ul><code>EMAIL</code>. Unencrypted email. Value is a string of up to 127 single-byte characters.</li><li><code>PHONE</code>. Unencrypted phone number.<blockquote><strong>Note:</strong> The PayPal sandbox does not support the <code>PHONE</code> recipient type.</blockquote></li><li><code>PAYPAL_ID</code>. Encrypted PayPal account number.</li></ul>If the <code>sender_batch_header</code> includes the <code>recipient_type</code> attribute, any payout item without its own <code>recipient_type</code> attribute uses the <code>recipient_type</code> value from <code>sender_batch_header</code>. If the <code>sender_batch_header</code> omits the <code>recipient_type</code> attribute, each payout item must include its own <code>recipient_type</code> value.
82 *
83 * @return string
84 */
85 public function getRecipientType()
86 {
87 return $this->recipient_type;
88 }
89
90 /**
91 * @deprecated This property is unused
92 */
93 public function setBatchStatus($batch_status)
94 {
95 $this->batch_status = $batch_status;
96 return $this;
97 }
98
99 /**
100 * @deprecated This property is unused
101 */
102 public function getBatchStatus()
103 {
104 return $this->batch_status;
105 }
106
107 }
108