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, List<PayoutItem> items) Parameterized Constructor

Method Summary

Methods

Modifier and Type	Method and Description
PayoutBatch	create(APIContext apiContext, Map<String,String> parameters) Create a payout batch resource by passing a sender_batch_header and an items array to the request URI.
PayoutBatch	create(String accessToken, Map<String,String> parameters) Create a payout batch resource by passing a sender_batch_header and an items array to the request URI.
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(String accessToken) You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.
static PayoutBatch	get(APIContext apiContext, String payoutBatchId) Obtain the status of a specific batch resource by passing the payout batch ID to the request URI.
static PayoutBatch	get(String accessToken, String payoutBatchId) Obtain the status of a specific batch resource by passing the payout batch ID to the request URI.
List<PayoutItem>	getItems() Getter for items
List<Links>	getLinks() Getter for links
PayoutSenderBatchHeader	getSenderBatchHeader() Getter for senderBatchHeader
Payout	setItems(List<PayoutItem> items) Setter for items
Payout	setLinks(List<Links> links) Setter for links
Payout	setSenderBatchHeader(PayoutSenderBatchHeader senderBatchHeader) Setter for senderBatchHeader

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

Payout

public Payout()

Default Constructor

Payout

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

Parameterized Constructor

Method Detail

setSenderBatchHeader

public Payout setSenderBatchHeader(PayoutSenderBatchHeader senderBatchHeader)

Setter for senderBatchHeader

getSenderBatchHeader

public PayoutSenderBatchHeader getSenderBatchHeader()

Getter for senderBatchHeader

setItems

public Payout setItems(List<PayoutItem> items)

Setter for items

getItems

public List<PayoutItem> getItems()

Getter for items

setLinks

public Payout setLinks(List<Links> links)

Setter for links

getLinks

public List<Links> getLinks()

Getter for links

createSynchronous

public PayoutBatch createSynchronous(String accessToken)
                              throws PayPalRESTException

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.

parameters - Map

Returns:

PayoutBatch

Throws:

PayPalRESTException

create

public PayoutBatch create(String accessToken,
                 Map<String,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:

accessToken - Access Token used for the API call.

parameters - Map

Returns:

PayoutBatch

Throws:

PayPalRESTException

create

public PayoutBatch create(APIContext apiContext,
                 Map<String,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(String accessToken,
              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:

accessToken - Access Token used for the API call.

payoutBatchId - String

Returns:

PayoutBatch

Throws:

PayPalRESTException

get

public static PayoutBatch get(APIContext apiContext,
              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