public class PayoutItem extends PayPalResource
| Constructor and Description |
|---|
PayoutItem()
Default Constructor
|
PayoutItem(Currency amount,
java.lang.String receiver)
Parameterized Constructor
|
| 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.
|
configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefaulttoJSON, toStringpublic PayoutItem()
public PayoutItem(Currency amount, java.lang.String receiver)
public static PayoutItemDetails get(java.lang.String accessToken, java.lang.String payoutItemId) throws PayPalRESTException
get(APIContext, String) instead.accessToken - Access Token used for the API call.payoutItemId - StringPayPalRESTExceptionpublic static PayoutItemDetails get(APIContext apiContext, java.lang.String payoutItemId) throws PayPalRESTException
apiContext - APIContext used for the API call.payoutItemId - StringPayPalRESTExceptionpublic static PayoutItemDetails cancel(java.lang.String accessToken, java.lang.String payoutItemId) throws PayPalRESTException
cancel(APIContext, String) instead.accessToken - Access Token used for the API call.payoutItemId - StringPayPalRESTExceptionpublic static PayoutItemDetails cancel(APIContext apiContext, java.lang.String payoutItemId) throws PayPalRESTException
apiContext - APIContext used for the API call.payoutItemId - StringPayPalRESTExceptionpublic java.lang.String getRecipientType()
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.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 Currency getAmount()
public java.lang.String getNote()
public java.lang.String getReceiver()
public java.lang.String getSenderItemId()
public PayoutItem setRecipientType(java.lang.String recipientType)
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.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 PayoutItem setAmount(Currency amount)
public PayoutItem setNote(java.lang.String note)
public PayoutItem setReceiver(java.lang.String receiver)
public PayoutItem setSenderItemId(java.lang.String senderItemId)
public boolean equals(java.lang.Object o)
equals in class PayPalModelprotected boolean canEqual(java.lang.Object other)
canEqual in class PayPalModelpublic int hashCode()
hashCode in class PayPalModel