com.paypal.api.payments

Class Payment

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Payment

Direct Known Subclasses:

FuturePayment

public class Payment
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Payment() Default Constructor
Payment(String intent, Payer payer) Parameterized Constructor

Method Summary

Methods

Modifier and Type	Method and Description
Payment	create(APIContext apiContext) Creates (and processes) a new Payment Resource.
Payment	create(String accessToken) Creates (and processes) a new Payment Resource.
Payment	execute(APIContext apiContext, PaymentExecution paymentExecution) Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal.
Payment	execute(String accessToken, PaymentExecution paymentExecution) Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal.
static Payment	get(APIContext apiContext, String paymentId) Obtain the Payment resource for the given identifier.
static Payment	get(String accessToken, String paymentId) Obtain the Payment resource for the given identifier.
Object	getCart() Getter for cart
String	getCreateTime() Getter for createTime
String	getExperienceProfileId() Getter for Experience Profile ID
String	getId() Getter for id
String	getIntent() Getter for intent
List<Links>	getLinks() Getter for links
Payee	getPayee()
Payer	getPayer() Getter for payer
RedirectUrls	getRedirectUrls() Getter for redirectUrls
String	getState() Getter for state
List<Transaction>	getTransactions() Getter for transactions
String	getUpdateTime() Getter for updateTime
static PaymentHistory	list(APIContext apiContext, Map<String,String> containerMap) Retrieves a list of Payment resources.
static PaymentHistory	list(String accessToken, Map<String,String> containerMap) Retrieves a list of Payment resources.
Payment	setCart(Object cart) Setter for cart
Payment	setCreateTime(String createTime) Setter for createTime
void	setExperienceProfileId(String experienceProfileId) Setter for Experience Profile ID
Payment	setId(String id) Setter for id
Payment	setIntent(String intent) Setter for intent
Payment	setLinks(List<Links> links) Setter for links
Payment	setPayee(Payee payee)
Payment	setPayer(Payer payer) Setter for payer
Payment	setRedirectUrls(RedirectUrls redirectUrls) Setter for redirectUrls
Payment	setState(String state) Setter for state
Payment	setTransactions(List<Transaction> transactions) Setter for transactions
Payment	setUpdateTime(String updateTime) Setter for updateTime
void	update(APIContext apiContext, List<Patch> patchRequest) Partially update a payment resource by by passing the payment_id in the request URI.
void	update(String accessToken, List<Patch> patchRequest) Partially update a payment resource by by passing the payment_id in the request URI.

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

Payment

public Payment()

Default Constructor

Payment

public Payment(String intent,
       Payer payer)

Parameterized Constructor

Method Detail

getPayee

public Payee getPayee()

setPayee

public Payment setPayee(Payee payee)

setId

public Payment setId(String id)

Setter for id

getId

public String getId()

Getter for id

setCreateTime

public Payment setCreateTime(String createTime)

Setter for createTime

getCreateTime

public String getCreateTime()

Getter for createTime

setUpdateTime

public Payment setUpdateTime(String updateTime)

Setter for updateTime

getUpdateTime

public String getUpdateTime()

Getter for updateTime

setIntent

public Payment setIntent(String intent)

Setter for intent

getIntent

public String getIntent()

Getter for intent

getExperienceProfileId

public String getExperienceProfileId()

Getter for Experience Profile ID

setExperienceProfileId

public void setExperienceProfileId(String experienceProfileId)

Setter for Experience Profile ID

setPayer

public Payment setPayer(Payer payer)

Setter for payer

getPayer

public Payer getPayer()

Getter for payer

setCart

public Payment setCart(Object cart)

Setter for cart

getCart

public Object getCart()

Getter for cart

setTransactions

public Payment setTransactions(List<Transaction> transactions)

Setter for transactions

getTransactions

public List<Transaction> getTransactions()

Getter for transactions

setState

public Payment setState(String state)

Setter for state

getState

public String getState()

Getter for state

setRedirectUrls

public Payment setRedirectUrls(RedirectUrls redirectUrls)

Setter for redirectUrls

getRedirectUrls

public RedirectUrls getRedirectUrls()

Getter for redirectUrls

setLinks

public Payment setLinks(List<Links> links)

Setter for links

getLinks

public List<Links> getLinks()

Getter for links

create

public Payment create(String accessToken)
               throws PayPalRESTException

Creates (and processes) a new Payment Resource.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Payment

Throws:

PayPalRESTException

create

public Payment create(APIContext apiContext)
               throws PayPalRESTException

Creates (and processes) a new Payment Resource.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Payment

Throws:

PayPalRESTException

get

public static Payment get(String accessToken,
          String paymentId)
                   throws PayPalRESTException

Obtain the Payment resource for the given identifier.

Parameters:

accessToken - Access Token used for the API call.

paymentId - String

Returns:

Payment

Throws:

PayPalRESTException

get

public static Payment get(APIContext apiContext,
          String paymentId)
                   throws PayPalRESTException

Obtain the Payment resource for the given identifier.

Parameters:

apiContext - APIContext used for the API call.

paymentId - String

Returns:

Payment

Throws:

PayPalRESTException

execute

public Payment execute(String accessToken,
              PaymentExecution paymentExecution)
                throws PayPalRESTException

Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal.

Parameters:

accessToken - Access Token used for the API call.

paymentExecution - PaymentExecution

Returns:

Payment

Throws:

PayPalRESTException

execute

public Payment execute(APIContext apiContext,
              PaymentExecution paymentExecution)
                throws PayPalRESTException

Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal.

Parameters:

apiContext - APIContext used for the API call.

paymentExecution - PaymentExecution

Returns:

Payment

Throws:

PayPalRESTException

update

public void update(String accessToken,
          List<Patch> patchRequest)
            throws PayPalRESTException

Partially update a payment resource by by passing the payment_id in the request URI. In addition, pass a patch_request_object in the body of the request JSON that specifies the operation to perform, path of the target location, and new value to apply. Please note that it is not possible to use patch after execute has been called.

Parameters:

accessToken - Access Token used for the API call.

patchRequest - List

Throws:

PayPalRESTException

update

public void update(APIContext apiContext,
          List<Patch> patchRequest)
            throws PayPalRESTException

Partially update a payment resource by by passing the payment_id in the request URI. In addition, pass a patch_request_object in the body of the request JSON that specifies the operation to perform, path of the target location, and new value to apply. Please note that it is not possible to use patch after execute has been called.

Parameters:

apiContext - APIContext used for the API call.

patchRequest - List

Throws:

PayPalRESTException

list

public static PaymentHistory list(String accessToken,
                  Map<String,String> containerMap)
                           throws PayPalRESTException

Retrieves a list of Payment resources.

Parameters:

accessToken - Access Token used for the API call.

containerMap - Map

Returns:

PaymentHistory

Throws:

PayPalRESTException

list

public static PaymentHistory list(APIContext apiContext,
                  Map<String,String> containerMap)
                           throws PayPalRESTException

Retrieves a list of Payment resources.

Parameters:

apiContext - APIContext used for the API call.

containerMap - Map

Returns:

PaymentHistory

Throws:

PayPalRESTException