Class PayoutSenderBatchHeader

Class PayoutSenderBatchHeader

The sender-provided batch header for a batch payout request.

PayPal\Common\PayPalModel

Extended by

PayPal\Api\PayoutSenderBatchHeader

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/PayoutSenderBatchHeader.php

Methods summary

`public`	# `setSenderBatchId( string $sender_batch_id )` A sender-specified ID number. Tracks the batch payout in an accounting system. Note: 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. A sender-specified ID number. Tracks the batch payout in an accounting system. Note: 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. Parameters `$sender_batch_id` Returns $this
`public string`	# `getSenderBatchId( )` A sender-specified ID number. Tracks the batch payout in an accounting system. Note: 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. A sender-specified ID number. Tracks the batch payout in an accounting system. Note: 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. Returns string
`public`	# `setEmailSubject( string $email_subject )` 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. 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. Parameters `$email_subject` Returns $this
`public string`	# `getEmailSubject( )` 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. 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. Returns string
`public`	# `setRecipientType( string $recipient_type )` The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. Parameters `$recipient_type` Returns $this
`public string`	# `getRecipientType( )` The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. The type of ID that identifies the payment receiver. Value is: EMAIL . Unencrypted email. Value is a string of up to 127 single-byte characters. PHONE . Unencrypted phone number. Note: The PayPal sandbox does not support the PHONE recipient type. PAYPAL_ID . Encrypted PayPal account number. If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header . If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value. Returns string
`public`	# `setBatchStatus( $batch_status )` Deprecated This property is unused
`public`	# `getBatchStatus( )` Deprecated This property is unused

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel