com.paypal.api.payments

Class PayoutItem

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.PayoutItem

public class PayoutItem
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
PayoutItem() Default Constructor
PayoutItem(Currency amount, java.lang.String receiver) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
static PayoutItemDetails	cancel(APIContext apiContext, java.lang.String payoutItemId) Cancels the unclaimed payment using the items id passed in the request URI.
static PayoutItemDetails	cancel(java.lang.String accessToken, java.lang.String payoutItemId) Deprecated. Please use cancel(APIContext, String) instead.
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
static PayoutItemDetails	get(APIContext apiContext, java.lang.String payoutItemId) Obtain the status of a payout item by passing the item ID to the request URI.
static PayoutItemDetails	get(java.lang.String accessToken, java.lang.String payoutItemId) Deprecated. Please use get(APIContext, String) instead.
Currency	getAmount() The amount of money to pay the receiver.
java.lang.String	getNote() Optional.
java.lang.String	getReceiver() The receiver of the payment.
java.lang.String	getRecipientType() The type of ID that identifies the payment receiver.
java.lang.String	getSenderItemId() A sender-specified ID number.
int	hashCode()
PayoutItem	setAmount(Currency amount) The amount of money to pay the receiver.
PayoutItem	setNote(java.lang.String note) Optional.
PayoutItem	setReceiver(java.lang.String receiver) The receiver of the payment.
PayoutItem	setRecipientType(java.lang.String recipientType) The type of ID that identifies the payment receiver.
PayoutItem	setSenderItemId(java.lang.String senderItemId) A sender-specified ID number.

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

configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

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

PayoutItem

public PayoutItem()

Default Constructor

PayoutItem

public PayoutItem(Currency amount,
                  java.lang.String receiver)

Parameterized Constructor

Method Detail

get

public static PayoutItemDetails get(java.lang.String accessToken,
                                    java.lang.String payoutItemId)
                             throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Obtain the status of a payout item by passing the item ID to the request URI.

Parameters:

accessToken - Access Token used for the API call.

payoutItemId - String

Returns:

PayoutItemDetails

Throws:

PayPalRESTException

get

public static PayoutItemDetails get(APIContext apiContext,
                                    java.lang.String payoutItemId)
                             throws PayPalRESTException

Obtain the status of a payout item by passing the item ID to the request URI.

Parameters:

apiContext - APIContext used for the API call.

payoutItemId - String

Returns:

PayoutItemDetails

Throws:

PayPalRESTException

cancel

public static PayoutItemDetails cancel(java.lang.String accessToken,
                                       java.lang.String payoutItemId)
                                throws PayPalRESTException

Deprecated. Please use cancel(APIContext, String) instead.

Cancels the unclaimed payment using the items id passed in the request URI. If an unclaimed item is not claimed within 30 days, the funds will be automatically returned to the sender. This call can be used to cancel the unclaimed item prior to the automatic 30-day return.

Parameters:

accessToken - Access Token used for the API call.

payoutItemId - String

Returns:

PayoutItemDetails

Throws:

PayPalRESTException

cancel

public static PayoutItemDetails cancel(APIContext apiContext,
                                       java.lang.String payoutItemId)
                                throws PayPalRESTException

Cancels the unclaimed payment using the items id passed in the request URI. If an unclaimed item is not claimed within 30 days, the funds will be automatically returned to the sender. This call can be used to cancel the unclaimed item prior to the automatic 30-day return.

Parameters:

apiContext - APIContext used for the API call.

payoutItemId - String

Returns:

PayoutItemDetails

Throws:

PayPalRESTException

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.

getAmount

public Currency getAmount()

The amount of money to pay the receiver.

getNote

public java.lang.String getNote()

Optional. A sender-specified note for notifications. Value is any string value.

getReceiver

public java.lang.String getReceiver()

The receiver of the payment. Corresponds to the `recipient_type` value in the request.

getSenderItemId

public java.lang.String getSenderItemId()

A sender-specified ID number. Tracks the batch payout in an accounting system.

setRecipientType

public PayoutItem 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

setAmount

public PayoutItem setAmount(Currency amount)

The amount of money to pay the receiver.

Returns:

this

setNote

public PayoutItem setNote(java.lang.String note)

Optional. A sender-specified note for notifications. Value is any string value.

Returns:

this

setReceiver

public PayoutItem setReceiver(java.lang.String receiver)

The receiver of the payment. Corresponds to the `recipient_type` value in the request.

Returns:

this

setSenderItemId

public PayoutItem setSenderItemId(java.lang.String senderItemId)

A sender-specified ID number. Tracks the batch payout in an accounting system.

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