com.paypal.api.payments

Class PayoutSenderBatchHeader

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.api.payments.PayoutSenderBatchHeader

public class PayoutSenderBatchHeader
extends PayPalModel

Constructor Summary

Constructors

Constructor and Description
PayoutSenderBatchHeader() Default Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.String	getEmailSubject() The subject line text for the email that PayPal sends when a payout item completes.
java.lang.String	getRecipientType() The type of ID that identifies the payment receiver.
java.lang.String	getSenderBatchId() A sender-specified ID number.
int	hashCode()
PayoutSenderBatchHeader	setEmailSubject(java.lang.String emailSubject) The subject line text for the email that PayPal sends when a payout item completes.
PayoutSenderBatchHeader	setRecipientType(java.lang.String recipientType) The type of ID that identifies the payment receiver.
PayoutSenderBatchHeader	setSenderBatchId(java.lang.String senderBatchId) A sender-specified ID number.

Methods inherited from class com.paypal.base.rest.PayPalModel

toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PayoutSenderBatchHeader

public PayoutSenderBatchHeader()

Default Constructor

Method Detail

getSenderBatchId

public java.lang.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.

getEmailSubject

public java.lang.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.

getRecipientType

public java.lang.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.

setSenderBatchId

public PayoutSenderBatchHeader setSenderBatchId(java.lang.String senderBatchId)

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:

this

setEmailSubject

public PayoutSenderBatchHeader setEmailSubject(java.lang.String emailSubject)

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:

this

setRecipientType

public PayoutSenderBatchHeader setRecipientType(java.lang.String recipientType)

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:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PayPalModel

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class PayPalModel

hashCode

public int hashCode()

Overrides:

hashCode in class PayPalModel