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, String receiver) Parameterized Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static PayoutItemDetails	cancel(APIContext apiContext, String payoutItemId) Cancels the unclaimed payment using the items id passed in the request URI.
static PayoutItemDetails	cancel(String accessToken, String payoutItemId) Cancels the unclaimed payment using the items id passed in the request URI.
static PayoutItemDetails	get(APIContext apiContext, String payoutItemId) Obtain the status of a payout item by passing the item ID to the request URI.
static PayoutItemDetails	get(String accessToken, String payoutItemId) Obtain the status of a payout item by passing the item ID to the request URI.
Currency	getAmount() Getter for amount
String	getNote() Getter for note
String	getReceiver() Getter for receiver
String	getRecipientType() Getter for recipientType
String	getSenderItemId() Getter for senderItemId
PayoutItem	setAmount(Currency amount) Setter for amount
PayoutItem	setNote(String note) Setter for note
PayoutItem	setReceiver(String receiver) Setter for receiver
PayoutItem	setRecipientType(String recipientType) Setter for recipientType
PayoutItem	setSenderItemId(String senderItemId) Setter for senderItemId

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

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

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

equals, hashCode, 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,
          String receiver)

Parameterized Constructor

Method Detail

setRecipientType

public PayoutItem setRecipientType(String recipientType)

Setter for recipientType

getRecipientType

public String getRecipientType()

Getter for recipientType

setAmount

public PayoutItem setAmount(Currency amount)

Setter for amount

getAmount

public Currency getAmount()

Getter for amount

setNote

public PayoutItem setNote(String note)

Setter for note

getNote

public String getNote()

Getter for note

setReceiver

public PayoutItem setReceiver(String receiver)

Setter for receiver

getReceiver

public String getReceiver()

Getter for receiver

setSenderItemId

public PayoutItem setSenderItemId(String senderItemId)

Setter for senderItemId

getSenderItemId

public String getSenderItemId()

Getter for senderItemId

get

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

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,
                    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(String accessToken,
                       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:

accessToken - Access Token used for the API call.

payoutItemId - String

Returns:

PayoutItemDetails

Throws:

PayPalRESTException

cancel

public static PayoutItemDetails cancel(APIContext apiContext,
                       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