com.paypal.api.payments

Class Payment

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Payment

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FuturePayment

public class Payment
extends PayPalResource

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

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.
List<BillingAgreementToken>	getBillingAgreementTokens() Getter for billingAgreementTokens
String	getCart() Getter for cart
String	getCreateTime() Getter for createTime
CreditFinancingOffered	getCreditFinancingOffered() Getter for creditFinancingOffered
String	getExperienceProfileId() Getter for experienceProfileId
List<Error>	getFailedTransactions() Getter for failedTransactions
String	getFailureReason() Getter for failureReason
String	getId() Getter for id
String	getIntent() Getter for intent
static String	getLastRequest() Returns the last request sent to the Service
static String	getLastResponse() Returns the last response returned by the Service
List<Links>	getLinks() Getter for links
String	getNoteToPayer() Getter for noteToPayer
Payee	getPayee() Getter for payee
Payer	getPayer() Getter for payer
PaymentInstruction	getPaymentInstruction() Getter for paymentInstruction
PotentialPayerInfo	getPotentialPayerInfo() Getter for potentialPayerInfo
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	setBillingAgreementTokens(List<BillingAgreementToken> billingAgreementTokens) Setter for billingAgreementTokens
Payment	setCart(String cart) Setter for cart
Payment	setCreateTime(String createTime) Setter for createTime
Payment	setCreditFinancingOffered(CreditFinancingOffered creditFinancingOffered) Setter for creditFinancingOffered
Payment	setExperienceProfileId(String experienceProfileId) Setter for experienceProfileId
Payment	setFailedTransactions(List<Error> failedTransactions) Setter for failedTransactions
Payment	setFailureReason(String failureReason) Setter for failureReason
Payment	setId(String id) Setter for id
Payment	setIntent(String intent) Setter for intent
Payment	setLinks(List<Links> links) Setter for links
Payment	setNoteToPayer(String noteToPayer) Setter for noteToPayer
Payment	setPayee(Payee payee) Setter for payee
Payment	setPayer(Payer payer) Setter for payer
Payment	setPaymentInstruction(PaymentInstruction paymentInstruction) Setter for paymentInstruction
Payment	setPotentialPayerInfo(PotentialPayerInfo potentialPayerInfo) Setter for potentialPayerInfo
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, 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

getLastRequest

public static String getLastRequest()

Returns the last request sent to the Service

Returns:

Last request sent to the server

getLastResponse

public static String getLastResponse()

Returns the last response returned by the Service

Returns:

Last response got from the Service

setId

public Payment setId(String id)

Setter for id

getId

public String getId()

Getter for id

setIntent

public Payment setIntent(String intent)

Setter for intent

getIntent

public String getIntent()

Getter for intent

setPayer

public Payment setPayer(Payer payer)

Setter for payer

getPayer

public Payer getPayer()

Getter for payer

setPotentialPayerInfo

public Payment setPotentialPayerInfo(PotentialPayerInfo potentialPayerInfo)

Setter for potentialPayerInfo

getPotentialPayerInfo

public PotentialPayerInfo getPotentialPayerInfo()

Getter for potentialPayerInfo

setPayee

public Payment setPayee(Payee payee)

Setter for payee

getPayee

public Payee getPayee()

Getter for payee

setCart

public Payment setCart(String cart)

Setter for cart

getCart

public String getCart()

Getter for cart

setTransactions

public Payment setTransactions(List<Transaction> transactions)

Setter for transactions

getTransactions

public List<Transaction> getTransactions()

Getter for transactions

setFailedTransactions

public Payment setFailedTransactions(List<Error> failedTransactions)

Setter for failedTransactions

getFailedTransactions

public List<Error> getFailedTransactions()

Getter for failedTransactions

setBillingAgreementTokens

public Payment setBillingAgreementTokens(List<BillingAgreementToken> billingAgreementTokens)

Setter for billingAgreementTokens

getBillingAgreementTokens

public List<BillingAgreementToken> getBillingAgreementTokens()

Getter for billingAgreementTokens

setCreditFinancingOffered

public Payment setCreditFinancingOffered(CreditFinancingOffered creditFinancingOffered)

Setter for creditFinancingOffered

getCreditFinancingOffered

public CreditFinancingOffered getCreditFinancingOffered()

Getter for creditFinancingOffered

setPaymentInstruction

public Payment setPaymentInstruction(PaymentInstruction paymentInstruction)

Setter for paymentInstruction

getPaymentInstruction

public PaymentInstruction getPaymentInstruction()

Getter for paymentInstruction

setState

public Payment setState(String state)

Setter for state

getState

public String getState()

Getter for state

setExperienceProfileId

public Payment setExperienceProfileId(String experienceProfileId)

Setter for experienceProfileId

getExperienceProfileId

public String getExperienceProfileId()

Getter for experienceProfileId

setNoteToPayer

public Payment setNoteToPayer(String noteToPayer)

Setter for noteToPayer

getNoteToPayer

public String getNoteToPayer()

Getter for noteToPayer

setRedirectUrls

public Payment setRedirectUrls(RedirectUrls redirectUrls)

Setter for redirectUrls

getRedirectUrls

public RedirectUrls getRedirectUrls()

Getter for redirectUrls

setFailureReason

public Payment setFailureReason(String failureReason)

Setter for failureReason

getFailureReason

public String getFailureReason()

Getter for failureReason

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

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