PHP Class PayPal\Api\PayoutSenderBatchHeader

The sender-provided batch header for a batch payout request.
Inheritance: extends PayPal\Common\PayPalModel
Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method Description
getBatchStatus ( )
getEmailSubject ( ) : string 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.
getRecipientType ( ) : string 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.
getSenderBatchId ( ) : string 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.
setBatchStatus ( $batch_status )
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.
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.
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.

Method Details

getBatchStatus() public method

Deprecation: This property is unused
public getBatchStatus ( )

getEmailSubject() public method

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.
public getEmailSubject ( ) : string
return string

getRecipientType() public method

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.
public getRecipientType ( ) : string
return string

getSenderBatchId() public method

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.
public getSenderBatchId ( ) : string
return string

setBatchStatus() public method

Deprecation: This property is unused
public setBatchStatus ( $batch_status )

setEmailSubject() public method

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.
public setEmailSubject ( string $email_subject )
$email_subject string

setRecipientType() public method

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.
public setRecipientType ( string $recipient_type )
$recipient_type string

setSenderBatchId() public method

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.
public setSenderBatchId ( string $sender_batch_id )
$sender_batch_id string