Payment (rest-api-sdk 1.14.0 API)

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(java.lang.String intent, Payer payer)
Parameterized Constructor

Constructors
Constructor and Description
`Payment()` Default Constructor
`Payment(java.lang.String intent, Payer payer)` Parameterized Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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.

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
  - Payment
```
public Payment()
```
    Default Constructor
  - Payment
```
public Payment(java.lang.String intent,
               Payer payer)
```
    Parameterized Constructor
- Method Detail
  - create
```
public Payment create(java.lang.String accessToken)
               throws PayPalRESTException
```
    Deprecated. Please use create(APIContext) instead.
    
    Creates and processes a payment. In the JSON request body, include a `payment` object with the intent, payer, and transactions. For PayPal payments, include redirect URLs in the `payment` object.
    
    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 payment. In the JSON request body, include a `payment` object with the intent, payer, and transactions. For PayPal payments, include redirect URLs in the `payment` object.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Payment
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Payment get(java.lang.String accessToken,
                          java.lang.String paymentId)
                   throws PayPalRESTException
```
    Deprecated. Please use get(APIContext, String) instead.
    
    Shows details for a payment, by ID.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    paymentId - String
    
    Returns:
    
    Payment
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Payment get(APIContext apiContext,
                          java.lang.String paymentId)
                   throws PayPalRESTException
```
    Shows details for a payment, by ID.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    paymentId - String
    
    Returns:
    
    Payment
    
    Throws:
    
    PayPalRESTException
  - execute
```
public Payment execute(java.lang.String accessToken,
                       PaymentExecution paymentExecution)
                throws PayPalRESTException
```
    Deprecated. Please use execute(APIContext, PaymentExecution) instead.
    
    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, or completes, a PayPal payment that the payer has approved. You can optionally update selective payment information when you execute a payment.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    paymentExecution - PaymentExecution
    
    Returns:
    
    Payment
    
    Throws:
    
    PayPalRESTException
  - update
```
public void update(java.lang.String accessToken,
                   java.util.List<Patch> patchRequest)
            throws PayPalRESTException
```
    Deprecated. Please use update(APIContext, List) instad.
    
    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,
                   java.util.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(java.lang.String accessToken,
                                  java.util.Map<java.lang.String,java.lang.String> containerMap)
                           throws PayPalRESTException
```
    Deprecated. Please use list(APIContext, Map) instead.
    
    List payments that were made to the merchant who issues the request. Payments can be in any state.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    containerMap - Map
    
    Returns:
    
    PaymentHistory
    
    Throws:
    
    PayPalRESTException
  - list
```
public static PaymentHistory list(APIContext apiContext,
                                  java.util.Map<java.lang.String,java.lang.String> containerMap)
                           throws PayPalRESTException
```
    List payments that were made to the merchant who issues the request. Payments can be in any state.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    containerMap - Map
    
    Returns:
    
    PaymentHistory
    
    Throws:
    
    PayPalRESTException
  - getId
```
public java.lang.String getId()
```
    Identifier of the payment resource created.
  - getIntent
```
public java.lang.String getIntent()
```
    Payment intent.
  - getPayer
```
public Payer getPayer()
```
    Source of the funds for this payment represented by a PayPal account or a direct credit card.
  - getPotentialPayerInfo
```
public PotentialPayerInfo getPotentialPayerInfo()
```
    Information that the merchant knows about the payer. This information is not definitive and only serves as a hint to the UI or any pre-processing logic.
  - getPayee
```
public Payee getPayee()
```
    Receiver of funds for this payment. **Readonly for PayPal external REST payments.**
  - getCart
```
public java.lang.String getCart()
```
    ID of the cart to execute the payment.
  - getTransactions
```
public java.util.List<Transaction> getTransactions()
```
    Transactional details including the amount and item details.
  - getFailedTransactions
```
public java.util.List<Error> getFailedTransactions()
```
    Applicable for advanced payments like multi seller payment (MSP) to support partial failures
  - getBillingAgreementTokens
```
public java.util.List<BillingAgreementToken> getBillingAgreementTokens()
```
    Collection of PayPal generated billing agreement tokens.
  - getCreditFinancingOffered
```
public CreditFinancingOffered getCreditFinancingOffered()
```
    Credit financing offered to payer on PayPal side. Returned in payment after payer opts-in
  - getPaymentInstruction
```
public PaymentInstruction getPaymentInstruction()
```
    Instructions for the payer to complete this payment. Applies to the German market and partners only.
  - getState
```
public java.lang.String getState()
```
    The state of the payment, authorization, or order transaction. The value is:
    - created. The transaction was successfully created.
    - approved. The buyer approved the transaction.
    - failed. The transaction request failed.
  - getExperienceProfileId
```
public java.lang.String getExperienceProfileId()
```
    PayPal generated identifier for the merchant's payment experience profile. Refer to [this](https://developer.paypal.com/docs/api/#payment-experience) link to create experience profile ID.
  - getNoteToPayer
```
public java.lang.String getNoteToPayer()
```
    free-form field for the use of clients to pass in a message to the payer
  - getRedirectUrls
```
public RedirectUrls getRedirectUrls()
```
    Set of redirect URLs you provide only for PayPal-based payments.
  - getFailureReason
```
public java.lang.String getFailureReason()
```
    Failure reason code returned when the payment failed for some valid reasons.
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    Payment creation time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    Payment update time as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getLinks
```
public java.util.List<Links> getLinks()
```
  - setId
```
public Payment setId(java.lang.String id)
```
    Identifier of the payment resource created.
    
    Returns:
    
    this
  - setIntent
```
public Payment setIntent(java.lang.String intent)
```
    Payment intent.
    
    Returns:
    
    this
  - setPayer
```
public Payment setPayer(Payer payer)
```
    Source of the funds for this payment represented by a PayPal account or a direct credit card.
    
    Returns:
    
    this
  - setPotentialPayerInfo
```
public Payment setPotentialPayerInfo(PotentialPayerInfo potentialPayerInfo)
```
    Information that the merchant knows about the payer. This information is not definitive and only serves as a hint to the UI or any pre-processing logic.
    
    Returns:
    
    this
  - setPayee
```
public Payment setPayee(Payee payee)
```
    Receiver of funds for this payment. **Readonly for PayPal external REST payments.**
    
    Returns:
    
    this
  - setCart
```
public Payment setCart(java.lang.String cart)
```
    ID of the cart to execute the payment.
    
    Returns:
    
    this
  - setTransactions
```
public Payment setTransactions(java.util.List<Transaction> transactions)
```
    Transactional details including the amount and item details.
    
    Returns:
    
    this
  - setFailedTransactions
```
public Payment setFailedTransactions(java.util.List<Error> failedTransactions)
```
    Applicable for advanced payments like multi seller payment (MSP) to support partial failures
    
    Returns:
    
    this
  - setBillingAgreementTokens
```
public Payment setBillingAgreementTokens(java.util.List<BillingAgreementToken> billingAgreementTokens)
```
    Collection of PayPal generated billing agreement tokens.
    
    Returns:
    
    this
  - setCreditFinancingOffered
```
public Payment setCreditFinancingOffered(CreditFinancingOffered creditFinancingOffered)
```
    Credit financing offered to payer on PayPal side. Returned in payment after payer opts-in
    
    Returns:
    
    this
  - setPaymentInstruction
```
public Payment setPaymentInstruction(PaymentInstruction paymentInstruction)
```
    Instructions for the payer to complete this payment. Applies to the German market and partners only.
    
    Returns:
    
    this
  - setState
```
public Payment setState(java.lang.String state)
```
    The state of the payment, authorization, or order transaction. The value is:
    - created. The transaction was successfully created.
    - approved. The buyer approved the transaction.
    - failed. The transaction request failed.
    Returns:
    
    this
  - setExperienceProfileId
```
public Payment setExperienceProfileId(java.lang.String experienceProfileId)
```
    PayPal generated identifier for the merchant's payment experience profile. Refer to [this](https://developer.paypal.com/docs/api/#payment-experience) link to create experience profile ID.
    
    Returns:
    
    this
  - setNoteToPayer
```
public Payment setNoteToPayer(java.lang.String noteToPayer)
```
    free-form field for the use of clients to pass in a message to the payer
    
    Returns:
    
    this
  - setRedirectUrls
```
public Payment setRedirectUrls(RedirectUrls redirectUrls)
```
    Set of redirect URLs you provide only for PayPal-based payments.
    
    Returns:
    
    this
  - setFailureReason
```
public Payment setFailureReason(java.lang.String failureReason)
```
    Failure reason code returned when the payment failed for some valid reasons.
    
    Returns:
    
    this
  - setCreateTime
```
public 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).
    
    Returns:
    
    this
  - setUpdateTime
```
public 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).
    
    Returns:
    
    this
  - setLinks
```
public Payment 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

Class Payment

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalResource

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

Payment

Payment

Method Detail

create

create

get

get

execute

execute

update

update

list

list

getId

getIntent

getPayer

getPotentialPayerInfo

getPayee

getCart

getTransactions

getFailedTransactions

getBillingAgreementTokens

getCreditFinancingOffered

getPaymentInstruction

getState

getExperienceProfileId

getNoteToPayer

getRedirectUrls

getFailureReason

getCreateTime

getUpdateTime

getLinks

setId

setIntent

setPayer

setPotentialPayerInfo

setPayee

setCart

setTransactions

setFailedTransactions

setBillingAgreementTokens

setCreditFinancingOffered

setPaymentInstruction

setState

setExperienceProfileId

setNoteToPayer

setRedirectUrls

setFailureReason

setCreateTime

setUpdateTime

setLinks

equals

canEqual

hashCode