public class Payment extends PayPalResource
| Constructor and Description |
|---|
Payment()
Default Constructor
|
Payment(java.lang.String intent,
Payer payer)
Parameterized Constructor
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
canEqual(java.lang.Object other) |
Payment |
create(APIContext apiContext)
Creates and processes a payment.
|
Payment |
create(java.lang.String accessToken)
Deprecated.
Please use
create(APIContext) instead. |
boolean |
equals(java.lang.Object o) |
Payment |
execute(APIContext apiContext,
PaymentExecution paymentExecution)
Executes, or completes, a PayPal payment that the payer has approved.
|
Payment |
execute(java.lang.String accessToken,
PaymentExecution paymentExecution)
Deprecated.
Please use
execute(APIContext, PaymentExecution) instead. |
static Payment |
get(APIContext apiContext,
java.lang.String paymentId)
Shows details for a payment, by ID.
|
static Payment |
get(java.lang.String accessToken,
java.lang.String paymentId)
Deprecated.
Please use
get(APIContext, String) instead. |
java.util.List<BillingAgreementToken> |
getBillingAgreementTokens()
Collection of PayPal generated billing agreement tokens.
|
java.lang.String |
getCart()
ID of the cart to execute the payment.
|
java.lang.String |
getCreateTime()
Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
|
CreditFinancingOffered |
getCreditFinancingOffered()
Credit financing offered to payer on PayPal side.
|
java.lang.String |
getExperienceProfileId()
PayPal generated identifier for the merchant's payment experience profile.
|
java.util.List<Error> |
getFailedTransactions()
Applicable for advanced payments like multi seller payment (MSP) to support partial failures
|
java.lang.String |
getFailureReason()
Failure reason code returned when the payment failed for some valid reasons.
|
java.lang.String |
getId()
Identifier of the payment resource created.
|
java.lang.String |
getIntent()
Payment intent.
|
java.util.List<Links> |
getLinks() |
java.lang.String |
getNoteToPayer()
free-form field for the use of clients to pass in a message to the payer
|
Payee |
getPayee()
Receiver of funds for this payment.
|
Payer |
getPayer()
Source of the funds for this payment represented by a PayPal account or a direct credit card.
|
PaymentInstruction |
getPaymentInstruction()
Instructions for the payer to complete this payment.
|
PotentialPayerInfo |
getPotentialPayerInfo()
Information that the merchant knows about the payer.
|
RedirectUrls |
getRedirectUrls()
Set of redirect URLs you provide only for PayPal-based payments.
|
java.lang.String |
getState()
The state of the payment, authorization, or order transaction.
|
java.util.List<Transaction> |
getTransactions()
Transactional details including the amount and item details.
|
java.lang.String |
getUpdateTime()
Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
|
int |
hashCode() |
static PaymentHistory |
list(APIContext apiContext,
java.util.Map<java.lang.String,java.lang.String> containerMap)
List payments that were made to the merchant who issues the request.
|
static PaymentHistory |
list(java.lang.String accessToken,
java.util.Map<java.lang.String,java.lang.String> containerMap)
Deprecated.
Please use
list(APIContext, Map) instead. |
Payment |
setBillingAgreementTokens(java.util.List<BillingAgreementToken> billingAgreementTokens)
Collection of PayPal generated billing agreement tokens.
|
Payment |
setCart(java.lang.String cart)
ID of the cart to execute the payment.
|
Payment |
setCreateTime(java.lang.String createTime)
Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
|
Payment |
setCreditFinancingOffered(CreditFinancingOffered creditFinancingOffered)
Credit financing offered to payer on PayPal side.
|
Payment |
setExperienceProfileId(java.lang.String experienceProfileId)
PayPal generated identifier for the merchant's payment experience profile.
|
Payment |
setFailedTransactions(java.util.List<Error> failedTransactions)
Applicable for advanced payments like multi seller payment (MSP) to support partial failures
|
Payment |
setFailureReason(java.lang.String failureReason)
Failure reason code returned when the payment failed for some valid reasons.
|
Payment |
setId(java.lang.String id)
Identifier of the payment resource created.
|
Payment |
setIntent(java.lang.String intent)
Payment intent.
|
Payment |
setLinks(java.util.List<Links> links) |
Payment |
setNoteToPayer(java.lang.String noteToPayer)
free-form field for the use of clients to pass in a message to the payer
|
Payment |
setPayee(Payee payee)
Receiver of funds for this payment.
|
Payment |
setPayer(Payer payer)
Source of the funds for this payment represented by a PayPal account or a direct credit card.
|
Payment |
setPaymentInstruction(PaymentInstruction paymentInstruction)
Instructions for the payer to complete this payment.
|
Payment |
setPotentialPayerInfo(PotentialPayerInfo potentialPayerInfo)
Information that the merchant knows about the payer.
|
Payment |
setRedirectUrls(RedirectUrls redirectUrls)
Set of redirect URLs you provide only for PayPal-based payments.
|
Payment |
setState(java.lang.String state)
The state of the payment, authorization, or order transaction.
|
Payment |
setTransactions(java.util.List<Transaction> transactions)
Transactional details including the amount and item details.
|
Payment |
setUpdateTime(java.lang.String updateTime)
Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
|
void |
update(APIContext apiContext,
java.util.List<Patch> patchRequest)
Partially update a payment resource by by passing the payment_id in the request URI.
|
void |
update(java.lang.String accessToken,
java.util.List<Patch> patchRequest)
Deprecated.
Please use
update(APIContext, List) instad. |
configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefaulttoJSON, toStringpublic Payment()
public Payment(java.lang.String intent,
Payer payer)
public Payment create(java.lang.String accessToken) throws PayPalRESTException
create(APIContext) instead.accessToken - Access Token used for the API call.PayPalRESTExceptionpublic Payment create(APIContext apiContext) throws PayPalRESTException
apiContext - APIContext used for the API call.PayPalRESTExceptionpublic static Payment get(java.lang.String accessToken, java.lang.String paymentId) throws PayPalRESTException
get(APIContext, String) instead.accessToken - Access Token used for the API call.paymentId - StringPayPalRESTExceptionpublic static Payment get(APIContext apiContext, java.lang.String paymentId) throws PayPalRESTException
apiContext - APIContext used for the API call.paymentId - StringPayPalRESTExceptionpublic Payment execute(java.lang.String accessToken, PaymentExecution paymentExecution) throws PayPalRESTException
execute(APIContext, PaymentExecution) instead.accessToken - Access Token used for the API call.paymentExecution - PaymentExecutionPayPalRESTExceptionpublic Payment execute(APIContext apiContext, PaymentExecution paymentExecution) throws PayPalRESTException
apiContext - APIContext used for the API call.paymentExecution - PaymentExecutionPayPalRESTExceptionpublic void update(java.lang.String accessToken,
java.util.List<Patch> patchRequest)
throws PayPalRESTException
update(APIContext, List) instad.accessToken - Access Token used for the API call.patchRequest - ListPayPalRESTExceptionpublic void update(APIContext apiContext, java.util.List<Patch> patchRequest) throws PayPalRESTException
apiContext - APIContext used for the API call.patchRequest - ListPayPalRESTExceptionpublic static PaymentHistory list(java.lang.String accessToken, java.util.Map<java.lang.String,java.lang.String> containerMap) throws PayPalRESTException
list(APIContext, Map) instead.accessToken - Access Token used for the API call.containerMap - MapPayPalRESTExceptionpublic static PaymentHistory list(APIContext apiContext, java.util.Map<java.lang.String,java.lang.String> containerMap) throws PayPalRESTException
apiContext - APIContext used for the API call.containerMap - MapPayPalRESTExceptionpublic java.lang.String getId()
public java.lang.String getIntent()
public Payer getPayer()
public PotentialPayerInfo getPotentialPayerInfo()
public Payee getPayee()
public java.lang.String getCart()
public java.util.List<Transaction> getTransactions()
public java.util.List<Error> getFailedTransactions()
public java.util.List<BillingAgreementToken> getBillingAgreementTokens()
public CreditFinancingOffered getCreditFinancingOffered()
public PaymentInstruction getPaymentInstruction()
public java.lang.String getState()
created. The transaction was successfully created.approved. The buyer approved the transaction.failed. The transaction request failed.public java.lang.String getExperienceProfileId()
public java.lang.String getNoteToPayer()
public RedirectUrls getRedirectUrls()
public java.lang.String getFailureReason()
public java.lang.String getCreateTime()
public java.lang.String getUpdateTime()
public java.util.List<Links> getLinks()
public Payment setId(java.lang.String id)
public Payment setIntent(java.lang.String intent)
public Payment setPayer(Payer payer)
public Payment setPotentialPayerInfo(PotentialPayerInfo potentialPayerInfo)
public Payment setPayee(Payee payee)
public Payment setCart(java.lang.String cart)
public Payment setTransactions(java.util.List<Transaction> transactions)
public Payment setFailedTransactions(java.util.List<Error> failedTransactions)
public Payment setBillingAgreementTokens(java.util.List<BillingAgreementToken> billingAgreementTokens)
public Payment setCreditFinancingOffered(CreditFinancingOffered creditFinancingOffered)
public Payment setPaymentInstruction(PaymentInstruction paymentInstruction)
public Payment setState(java.lang.String state)
created. The transaction was successfully created.approved. The buyer approved the transaction.failed. The transaction request failed.public Payment setExperienceProfileId(java.lang.String experienceProfileId)
public Payment setNoteToPayer(java.lang.String noteToPayer)
public Payment setRedirectUrls(RedirectUrls redirectUrls)
public Payment setFailureReason(java.lang.String failureReason)
public Payment setCreateTime(java.lang.String createTime)
public Payment setUpdateTime(java.lang.String updateTime)
public boolean equals(java.lang.Object o)
equals in class PayPalModelprotected boolean canEqual(java.lang.Object other)
canEqual in class PayPalModelpublic int hashCode()
hashCode in class PayPalModel