com.paypal.api.payments

Class Payout

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Payout

public class Payout
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Payout() Default Constructor
Payout(PayoutSenderBatchHeader senderBatchHeader, java.util.List<PayoutItem> items) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
PayoutBatch	create(APIContext apiContext, java.util.Map<java.lang.String,java.lang.String> parameters) Create a payout batch resource by passing a sender_batch_header and an items array to the request URI.
PayoutBatch	create(java.lang.String accessToken, java.util.Map<java.lang.String,java.lang.String> parameters) Deprecated. Please use create(APIContext, Map) instead.
PayoutBatch	createSynchronous(APIContext apiContext) You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.
PayoutBatch	createSynchronous(java.lang.String accessToken) Deprecated. Please use createSynchronous(APIContext) instead.
boolean	equals(java.lang.Object o)
static PayoutBatch	get(APIContext apiContext, java.lang.String payoutBatchId) Obtain the status of a specific batch resource by passing the payout batch ID to the request URI.
static PayoutBatch	get(java.lang.String accessToken, java.lang.String payoutBatchId) Deprecated. Please use get(APIContext, String) instead.
java.util.List<PayoutItem>	getItems() An array of payout items (that is, a set of individual payouts).
java.util.List<Links>	getLinks()
PayoutSenderBatchHeader	getSenderBatchHeader() The original batch header as provided by the payment sender.
int	hashCode()
Payout	setItems(java.util.List<PayoutItem> items) An array of payout items (that is, a set of individual payouts).
Payout	setLinks(java.util.List<Links> links)
Payout	setSenderBatchHeader(PayoutSenderBatchHeader senderBatchHeader) The original batch header as provided by the payment sender.

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

Payout

public Payout()

Default Constructor

Payout

public Payout(PayoutSenderBatchHeader senderBatchHeader,
              java.util.List<PayoutItem> items)

Parameterized Constructor

Method Detail

createSynchronous

public PayoutBatch createSynchronous(java.lang.String accessToken)
                              throws PayPalRESTException

Deprecated. Please use createSynchronous(APIContext) instead.

You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.

Parameters:

accessToken - Access Token used for the API call.

Returns:

PayoutBatch

Throws:

PayPalRESTException

createSynchronous

public PayoutBatch createSynchronous(APIContext apiContext)
                              throws PayPalRESTException

You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.

Parameters:

apiContext - APIContext used for the API call.

Returns:

PayoutBatch

Throws:

PayPalRESTException

create

public PayoutBatch create(java.lang.String accessToken,
                          java.util.Map<java.lang.String,java.lang.String> parameters)
                   throws PayPalRESTException

Deprecated. Please use create(APIContext, Map) instead.

Create a payout batch resource by passing a sender_batch_header and an items array to the request URI. The sender_batch_header contains payout parameters that describe the handling of a batch resource while the items array conatins payout items.

Parameters:

accessToken - Access Token used for the API call.

parameters - Map

Returns:

PayoutBatch

Throws:

PayPalRESTException

create

public PayoutBatch create(APIContext apiContext,
                          java.util.Map<java.lang.String,java.lang.String> parameters)
                   throws PayPalRESTException

Create a payout batch resource by passing a sender_batch_header and an items array to the request URI. The sender_batch_header contains payout parameters that describe the handling of a batch resource while the items array conatins payout items.

Parameters:

apiContext - APIContext used for the API call.

parameters - Map

Returns:

PayoutBatch

Throws:

PayPalRESTException

get

public static PayoutBatch get(java.lang.String accessToken,
                              java.lang.String payoutBatchId)
                       throws PayPalRESTException

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

Obtain the status of a specific batch resource by passing the payout batch ID to the request URI. You can issue this call multiple times to get the current status.

Parameters:

accessToken - Access Token used for the API call.

payoutBatchId - String

Returns:

PayoutBatch

Throws:

PayPalRESTException

get

public static PayoutBatch get(APIContext apiContext,
                              java.lang.String payoutBatchId)
                       throws PayPalRESTException

Obtain the status of a specific batch resource by passing the payout batch ID to the request URI. You can issue this call multiple times to get the current status.

Parameters:

apiContext - APIContext used for the API call.

payoutBatchId - String

Returns:

PayoutBatch

Throws:

PayPalRESTException

getSenderBatchHeader

public PayoutSenderBatchHeader getSenderBatchHeader()

The original batch header as provided by the payment sender.

getItems

public java.util.List<PayoutItem> getItems()

An array of payout items (that is, a set of individual payouts).

getLinks

public java.util.List<Links> getLinks()

setSenderBatchHeader

public Payout setSenderBatchHeader(PayoutSenderBatchHeader senderBatchHeader)

The original batch header as provided by the payment sender.

Returns:

this

setItems

public Payout setItems(java.util.List<PayoutItem> items)

An array of payout items (that is, a set of individual payouts).

Returns:

this

setLinks

public Payout setLinks(java.util.List<Links> links)

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