Sale (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.base.rest.PayPalResource
  - - com.paypal.api.payments.Sale

public class Sale
extends PayPalResource

Constructor Summary

Constructors
Constructor and Description
`Sale()` Default Constructor
`Sale(java.lang.String id, Amount amount, java.lang.String state, java.lang.String parentPayment, java.lang.String createTime)` 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)`
`boolean`	`equals(java.lang.Object o)`
`static Sale`	`get(APIContext apiContext, java.lang.String saleId)` Shows details for a sale, by ID.
`static Sale`	`get(java.lang.String accessToken, java.lang.String saleId)` Deprecated. Please use `get(APIContext, String)` instead.
`Amount`	`getAmount()` Amount being collected.
`java.lang.String`	`getBillingAgreementId()` ID of the billing agreement used as reference to execute this transaction.
`java.lang.String`	`getClearingTime()` Expected clearing time for eCheck Transactions.
`java.lang.String`	`getCreateTime()` Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
`java.lang.String`	`getExchangeRate()` Exchange rate applied for this transaction.
`FmfDetails`	`getFmfDetails()` Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
`java.lang.String`	`getId()` Identifier of the sale transaction.
`java.util.List<Links>`	`getLinks()`
`java.lang.String`	`getParentPayment()` ID of the payment resource on which this transaction is based.
`java.util.List<java.lang.String>`	`getPaymentHoldReasons()` Reasons for PayPal holding recipient fund.
`java.lang.String`	`getPaymentHoldStatus()` Status of the Recipient Fund.
`java.lang.String`	`getPaymentMode()` Specifies payment mode of the transaction.
`ProcessorResponse`	`getProcessorResponse()` Response codes returned by the processor concerning the submitted payment.
`java.lang.String`	`getProtectionEligibility()` The level of seller protection in force for the transaction.
`java.lang.String`	`getProtectionEligibilityType()` The kind of seller protection in force for the transaction.
`java.lang.String`	`getPurchaseUnitReferenceId()` Identifier to the purchase or transaction unit corresponding to this sale transaction.
`java.lang.String`	`getReasonCode()` Reason code for the transaction state being Pending or Reversed.
`java.lang.String`	`getReceiptId()` Receipt id is a payment identification number returned for guest users to identify the payment.
`Currency`	`getReceivableAmount()` Net amount the merchant receives for this transaction in their receivable currency.
`java.lang.String`	`getState()` State of the sale transaction.
`Currency`	`getTransactionFee()` Transaction fee applicable for this payment.
`java.lang.String`	`getUpdateTime()` Time the resource was last updated in UTC ISO8601 format.
`int`	`hashCode()`
`Refund`	`refund(APIContext apiContext, Refund refund)` Deprecated. Please use `refund(APIContext, RefundRequest)` instead Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an `amount` object in the JSON request body.
`DetailedRefund`	`refund(APIContext apiContext, RefundRequest refundRequest)` Refunds a sale, by ID.
`Refund`	`refund(java.lang.String accessToken, Refund refund)` Deprecated. Please use `refund(APIContext, Refund)` instead.
`Sale`	`setAmount(Amount amount)` Amount being collected.
`Sale`	`setBillingAgreementId(java.lang.String billingAgreementId)` ID of the billing agreement used as reference to execute this transaction.
`Sale`	`setClearingTime(java.lang.String clearingTime)` Expected clearing time for eCheck Transactions.
`Sale`	`setCreateTime(java.lang.String createTime)` Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
`Sale`	`setExchangeRate(java.lang.String exchangeRate)` Exchange rate applied for this transaction.
`Sale`	`setFmfDetails(FmfDetails fmfDetails)` Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action.
`Sale`	`setId(java.lang.String id)` Identifier of the sale transaction.
`Sale`	`setLinks(java.util.List<Links> links)`
`Sale`	`setParentPayment(java.lang.String parentPayment)` ID of the payment resource on which this transaction is based.
`Sale`	`setPaymentHoldReasons(java.util.List<java.lang.String> paymentHoldReasons)` Reasons for PayPal holding recipient fund.
`Sale`	`setPaymentHoldStatus(java.lang.String paymentHoldStatus)` Status of the Recipient Fund.
`Sale`	`setPaymentMode(java.lang.String paymentMode)` Specifies payment mode of the transaction.
`Sale`	`setProcessorResponse(ProcessorResponse processorResponse)` Response codes returned by the processor concerning the submitted payment.
`Sale`	`setProtectionEligibility(java.lang.String protectionEligibility)` The level of seller protection in force for the transaction.
`Sale`	`setProtectionEligibilityType(java.lang.String protectionEligibilityType)` The kind of seller protection in force for the transaction.
`Sale`	`setPurchaseUnitReferenceId(java.lang.String purchaseUnitReferenceId)` Identifier to the purchase or transaction unit corresponding to this sale transaction.
`Sale`	`setReasonCode(java.lang.String reasonCode)` Reason code for the transaction state being Pending or Reversed.
`Sale`	`setReceiptId(java.lang.String receiptId)` Receipt id is a payment identification number returned for guest users to identify the payment.
`Sale`	`setReceivableAmount(Currency receivableAmount)` Net amount the merchant receives for this transaction in their receivable currency.
`Sale`	`setState(java.lang.String state)` State of the sale transaction.
`Sale`	`setTransactionFee(Currency transactionFee)` Transaction fee applicable for this payment.
`Sale`	`setUpdateTime(java.lang.String updateTime)` Time the resource was last updated in UTC ISO8601 format.

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
  - Sale
```
public Sale()
```
    Default Constructor
  - Sale
```
public Sale(java.lang.String id,
            Amount amount,
            java.lang.String state,
            java.lang.String parentPayment,
            java.lang.String createTime)
```
    Parameterized Constructor
- Method Detail
  - get
```
public static Sale get(java.lang.String accessToken,
                       java.lang.String saleId)
                throws PayPalRESTException
```
    Deprecated. Please use get(APIContext, String) instead.
    
    Shows details for a sale, by ID. Returns only sales that were created through the REST API.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    saleId - String
    
    Returns:
    
    Sale
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Sale get(APIContext apiContext,
                       java.lang.String saleId)
                throws PayPalRESTException
```
    Shows details for a sale, by ID. Returns only sales that were created through the REST API.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    saleId - String
    
    Returns:
    
    Sale
    
    Throws:
    
    PayPalRESTException
  - refund
```
@Deprecated
public Refund refund(java.lang.String accessToken,
                                 Refund refund)
                          throws PayPalRESTException
```
    Deprecated. Please use refund(APIContext, Refund) instead.
    
    Creates (and processes) a new Refund Transaction added as a related resource.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    refund - Refund
    
    Returns:
    
    Refund
    
    Throws:
    
    PayPalRESTException
  - refund
```
@Deprecated
public Refund refund(APIContext apiContext,
                                 Refund refund)
                          throws PayPalRESTException
```
    Deprecated. Please use refund(APIContext, RefundRequest) instead Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an `amount` object in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    refund - Refund
    
    Returns:
    
    Refund
    
    Throws:
    
    PayPalRESTException
  - refund
```
public DetailedRefund refund(APIContext apiContext,
                             RefundRequest refundRequest)
                      throws PayPalRESTException
```
    Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an `amount` object in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    refundRequest - RefundRequest
    
    Returns:
    
    DetailedRefund
    
    Throws:
    
    PayPalRESTException
  - getId
```
public java.lang.String getId()
```
    Identifier of the sale transaction.
  - getPurchaseUnitReferenceId
```
public java.lang.String getPurchaseUnitReferenceId()
```
    Identifier to the purchase or transaction unit corresponding to this sale transaction.
  - getAmount
```
public Amount getAmount()
```
    Amount being collected.
  - getPaymentMode
```
public java.lang.String getPaymentMode()
```
    Specifies payment mode of the transaction. Only supported when the `payment_method` is set to `paypal`.
  - getState
```
public java.lang.String getState()
```
    State of the sale transaction.
  - getReasonCode
```
public java.lang.String getReasonCode()
```
    Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`.
  - getProtectionEligibility
```
public java.lang.String getProtectionEligibility()
```
    The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`.
  - getProtectionEligibilityType
```
public java.lang.String getProtectionEligibilityType()
```
    The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the `payment_method` is set to `paypal`.
  - getClearingTime
```
public java.lang.String getClearingTime()
```
    Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the `payment_method` is set to `paypal`.
  - getPaymentHoldStatus
```
public java.lang.String getPaymentHoldStatus()
```
    Status of the Recipient Fund. For now, it will be returned only when fund status is held
  - getPaymentHoldReasons
```
public java.util.List<java.lang.String> getPaymentHoldReasons()
```
    Reasons for PayPal holding recipient fund. It is set only if payment hold status is held
  - getTransactionFee
```
public Currency getTransactionFee()
```
    Transaction fee applicable for this payment.
  - getReceivableAmount
```
public Currency getReceivableAmount()
```
    Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
  - getExchangeRate
```
public java.lang.String getExchangeRate()
```
    Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
  - getFmfDetails
```
public FmfDetails getFmfDetails()
```
    Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/) for more information.
  - getReceiptId
```
public java.lang.String getReceiptId()
```
    Receipt id is a payment identification number returned for guest users to identify the payment.
  - getParentPayment
```
public java.lang.String getParentPayment()
```
    ID of the payment resource on which this transaction is based.
  - getProcessorResponse
```
public ProcessorResponse getProcessorResponse()
```
    Response codes returned by the processor concerning the submitted payment. Only supported when the `payment_method` is set to `credit_card`.
  - getBillingAgreementId
```
public java.lang.String getBillingAgreementId()
```
    ID of the billing agreement used as reference to execute this transaction.
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    Time the resource was last updated in UTC ISO8601 format.
  - getLinks
```
public java.util.List<Links> getLinks()
```
  - setId
```
public Sale setId(java.lang.String id)
```
    Identifier of the sale transaction.
    
    Returns:
    
    this
  - setPurchaseUnitReferenceId
```
public Sale setPurchaseUnitReferenceId(java.lang.String purchaseUnitReferenceId)
```
    Identifier to the purchase or transaction unit corresponding to this sale transaction.
    
    Returns:
    
    this
  - setAmount
```
public Sale setAmount(Amount amount)
```
    Amount being collected.
    
    Returns:
    
    this
  - setPaymentMode
```
public Sale setPaymentMode(java.lang.String paymentMode)
```
    Specifies payment mode of the transaction. Only supported when the `payment_method` is set to `paypal`.
    
    Returns:
    
    this
  - setState
```
public Sale setState(java.lang.String state)
```
    State of the sale transaction.
    
    Returns:
    
    this
  - setReasonCode
```
public Sale setReasonCode(java.lang.String reasonCode)
```
    Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`.
    
    Returns:
    
    this
  - setProtectionEligibility
```
public Sale setProtectionEligibility(java.lang.String protectionEligibility)
```
    The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`.
    
    Returns:
    
    this
  - setProtectionEligibilityType
```
public Sale setProtectionEligibilityType(java.lang.String protectionEligibilityType)
```
    The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the `payment_method` is set to `paypal`.
    
    Returns:
    
    this
  - setClearingTime
```
public Sale setClearingTime(java.lang.String clearingTime)
```
    Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the `payment_method` is set to `paypal`.
    
    Returns:
    
    this
  - setPaymentHoldStatus
```
public Sale setPaymentHoldStatus(java.lang.String paymentHoldStatus)
```
    Status of the Recipient Fund. For now, it will be returned only when fund status is held
    
    Returns:
    
    this
  - setPaymentHoldReasons
```
public Sale setPaymentHoldReasons(java.util.List<java.lang.String> paymentHoldReasons)
```
    Reasons for PayPal holding recipient fund. It is set only if payment hold status is held
    
    Returns:
    
    this
  - setTransactionFee
```
public Sale setTransactionFee(Currency transactionFee)
```
    Transaction fee applicable for this payment.
    
    Returns:
    
    this
  - setReceivableAmount
```
public Sale setReceivableAmount(Currency receivableAmount)
```
    Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
    
    Returns:
    
    this
  - setExchangeRate
```
public Sale setExchangeRate(java.lang.String exchangeRate)
```
    Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
    
    Returns:
    
    this
  - setFmfDetails
```
public Sale setFmfDetails(FmfDetails fmfDetails)
```
    Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/) for more information.
    
    Returns:
    
    this
  - setReceiptId
```
public Sale setReceiptId(java.lang.String receiptId)
```
    Receipt id is a payment identification number returned for guest users to identify the payment.
    
    Returns:
    
    this
  - setParentPayment
```
public Sale setParentPayment(java.lang.String parentPayment)
```
    ID of the payment resource on which this transaction is based.
    
    Returns:
    
    this
  - setProcessorResponse
```
public Sale setProcessorResponse(ProcessorResponse processorResponse)
```
    Response codes returned by the processor concerning the submitted payment. Only supported when the `payment_method` is set to `credit_card`.
    
    Returns:
    
    this
  - setBillingAgreementId
```
public Sale setBillingAgreementId(java.lang.String billingAgreementId)
```
    ID of the billing agreement used as reference to execute this transaction.
    
    Returns:
    
    this
  - setCreateTime
```
public Sale setCreateTime(java.lang.String createTime)
```
    Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
    
    Returns:
    
    this
  - setUpdateTime
```
public Sale setUpdateTime(java.lang.String updateTime)
```
    Time the resource was last updated in UTC ISO8601 format.
    
    Returns:
    
    this
  - setLinks
```
public Sale 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 Sale

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

Sale

Sale

Method Detail

get

get

refund

refund

refund

getId

getPurchaseUnitReferenceId

getAmount

getPaymentMode

getState

getReasonCode

getProtectionEligibility

getProtectionEligibilityType

getClearingTime

getPaymentHoldStatus

getPaymentHoldReasons

getTransactionFee

getReceivableAmount

getExchangeRate

getFmfDetails

getReceiptId

getParentPayment

getProcessorResponse

getBillingAgreementId

getCreateTime

getUpdateTime

getLinks

setId

setPurchaseUnitReferenceId

setAmount

setPaymentMode

setState

setReasonCode

setProtectionEligibility

setProtectionEligibilityType

setClearingTime

setPaymentHoldStatus

setPaymentHoldReasons

setTransactionFee

setReceivableAmount

setExchangeRate

setFmfDetails

setReceiptId

setParentPayment

setProcessorResponse

setBillingAgreementId

setCreateTime

setUpdateTime

setLinks

equals

canEqual

hashCode