com.paypal.api.payments

Class Sale

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Sale

All Implemented Interfaces:

Serializable

public class Sale
extends PayPalResource

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Sale() Default Constructor
Sale(String id, Amount amount, String state, String parentPayment, String createTime) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
static Sale	get(APIContext apiContext, String saleId) Obtain the Sale transaction resource for the given identifier.
static Sale	get(String accessToken, String saleId) Obtain the Sale transaction resource for the given identifier.
Amount	getAmount() Getter for amount
String	getBillingAgreementId() Getter for billingAgreementId
String	getClearingTime() Getter for clearingTime
String	getCreateTime() Getter for createTime
String	getExchangeRate() Getter for exchangeRate
FmfDetails	getFmfDetails() Getter for fmfDetails
String	getId() Getter for id
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	getParentPayment() Getter for parentPayment
List<String>	getPaymentHoldReasons() Getter for paymentHoldReasons
String	getPaymentHoldStatus() Getter for paymentHoldStatus
String	getPaymentMode() Getter for paymentMode
ProcessorResponse	getProcessorResponse() Getter for processorResponse
String	getProtectionEligibility() Getter for protectionEligibility
String	getProtectionEligibilityType() Getter for protectionEligibilityType
String	getPurchaseUnitReferenceId() Getter for purchaseUnitReferenceId
String	getReasonCode() Getter for reasonCode
String	getReceiptId() Getter for receiptId
Currency	getReceivableAmount() Getter for receivableAmount
String	getState() Getter for state
Currency	getTransactionFee() Getter for transactionFee
String	getUpdateTime() Getter for updateTime
Refund	refund(APIContext apiContext, Refund refund) Creates (and processes) a new Refund Transaction added as a related resource.
Refund	refund(String accessToken, Refund refund) Creates (and processes) a new Refund Transaction added as a related resource.
Sale	setAmount(Amount amount) Setter for amount
Sale	setBillingAgreementId(String billingAgreementId) Setter for billingAgreementId
Sale	setClearingTime(String clearingTime) Setter for clearingTime
Sale	setCreateTime(String createTime) Setter for createTime
Sale	setExchangeRate(String exchangeRate) Setter for exchangeRate
Sale	setFmfDetails(FmfDetails fmfDetails) Setter for fmfDetails
Sale	setId(String id) Setter for id
Sale	setLinks(List<Links> links) Setter for links
Sale	setParentPayment(String parentPayment) Setter for parentPayment
Sale	setPaymentHoldReasons(List<String> paymentHoldReasons) Setter for paymentHoldReasons
Sale	setPaymentHoldStatus(String paymentHoldStatus) Setter for paymentHoldStatus
Sale	setPaymentMode(String paymentMode) Setter for paymentMode
Sale	setProcessorResponse(ProcessorResponse processorResponse) Setter for processorResponse
Sale	setProtectionEligibility(String protectionEligibility) Setter for protectionEligibility
Sale	setProtectionEligibilityType(String protectionEligibilityType) Setter for protectionEligibilityType
Sale	setPurchaseUnitReferenceId(String purchaseUnitReferenceId) Setter for purchaseUnitReferenceId
Sale	setReasonCode(String reasonCode) Setter for reasonCode
Sale	setReceiptId(String receiptId) Setter for receiptId
Sale	setReceivableAmount(Currency receivableAmount) Setter for receivableAmount
Sale	setState(String state) Setter for state
Sale	setTransactionFee(Currency transactionFee) Setter for transactionFee
Sale	setUpdateTime(String updateTime) Setter for updateTime

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

configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, 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

Sale

public Sale()

Default Constructor

Sale

public Sale(String id,
            Amount amount,
            String state,
            String parentPayment,
            String createTime)

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 Sale setId(String id)

Setter for id

getId

public String getId()

Getter for id

setPurchaseUnitReferenceId

public Sale setPurchaseUnitReferenceId(String purchaseUnitReferenceId)

Setter for purchaseUnitReferenceId

getPurchaseUnitReferenceId

public String getPurchaseUnitReferenceId()

Getter for purchaseUnitReferenceId

setAmount

public Sale setAmount(Amount amount)

Setter for amount

getAmount

public Amount getAmount()

Getter for amount

setPaymentMode

public Sale setPaymentMode(String paymentMode)

Setter for paymentMode

getPaymentMode

public String getPaymentMode()

Getter for paymentMode

setState

public Sale setState(String state)

Setter for state

getState

public String getState()

Getter for state

setReasonCode

public Sale setReasonCode(String reasonCode)

Setter for reasonCode

getReasonCode

public String getReasonCode()

Getter for reasonCode

setProtectionEligibility

public Sale setProtectionEligibility(String protectionEligibility)

Setter for protectionEligibility

getProtectionEligibility

public String getProtectionEligibility()

Getter for protectionEligibility

setProtectionEligibilityType

public Sale setProtectionEligibilityType(String protectionEligibilityType)

Setter for protectionEligibilityType

getProtectionEligibilityType

public String getProtectionEligibilityType()

Getter for protectionEligibilityType

setClearingTime

public Sale setClearingTime(String clearingTime)

Setter for clearingTime

getClearingTime

public String getClearingTime()

Getter for clearingTime

setPaymentHoldStatus

public Sale setPaymentHoldStatus(String paymentHoldStatus)

Setter for paymentHoldStatus

getPaymentHoldStatus

public String getPaymentHoldStatus()

Getter for paymentHoldStatus

setPaymentHoldReasons

public Sale setPaymentHoldReasons(List<String> paymentHoldReasons)

Setter for paymentHoldReasons

getPaymentHoldReasons

public List<String> getPaymentHoldReasons()

Getter for paymentHoldReasons

setTransactionFee

public Sale setTransactionFee(Currency transactionFee)

Setter for transactionFee

getTransactionFee

public Currency getTransactionFee()

Getter for transactionFee

setReceivableAmount

public Sale setReceivableAmount(Currency receivableAmount)

Setter for receivableAmount

getReceivableAmount

public Currency getReceivableAmount()

Getter for receivableAmount

setExchangeRate

public Sale setExchangeRate(String exchangeRate)

Setter for exchangeRate

getExchangeRate

public String getExchangeRate()

Getter for exchangeRate

setFmfDetails

public Sale setFmfDetails(FmfDetails fmfDetails)

Setter for fmfDetails

getFmfDetails

public FmfDetails getFmfDetails()

Getter for fmfDetails

setReceiptId

public Sale setReceiptId(String receiptId)

Setter for receiptId

getReceiptId

public String getReceiptId()

Getter for receiptId

setParentPayment

public Sale setParentPayment(String parentPayment)

Setter for parentPayment

getParentPayment

public String getParentPayment()

Getter for parentPayment

setProcessorResponse

public Sale setProcessorResponse(ProcessorResponse processorResponse)

Setter for processorResponse

getProcessorResponse

public ProcessorResponse getProcessorResponse()

Getter for processorResponse

setBillingAgreementId

public Sale setBillingAgreementId(String billingAgreementId)

Setter for billingAgreementId

getBillingAgreementId

public String getBillingAgreementId()

Getter for billingAgreementId

setCreateTime

public Sale setCreateTime(String createTime)

Setter for createTime

getCreateTime

public String getCreateTime()

Getter for createTime

setUpdateTime

public Sale setUpdateTime(String updateTime)

Setter for updateTime

getUpdateTime

public String getUpdateTime()

Getter for updateTime

setLinks

public Sale setLinks(List<Links> links)

Setter for links

getLinks

public List<Links> getLinks()

Getter for links

get

public static Sale get(String accessToken,
                       String saleId)
                throws PayPalRESTException

Obtain the Sale transaction resource for the given identifier.

Parameters:

accessToken - Access Token used for the API call.

saleId - String

Returns:

Sale

Throws:

PayPalRESTException

get

public static Sale get(APIContext apiContext,
                       String saleId)
                throws PayPalRESTException

Obtain the Sale transaction resource for the given identifier.

Parameters:

apiContext - APIContext used for the API call.

saleId - String

Returns:

Sale

Throws:

PayPalRESTException

refund

public Refund refund(String accessToken,
                     Refund refund)
              throws PayPalRESTException

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

public Refund refund(APIContext apiContext,
                     Refund refund)
              throws PayPalRESTException

Creates (and processes) a new Refund Transaction added as a related resource.

Parameters:

apiContext - APIContext used for the API call.

refund - Refund

Returns:

Refund

Throws:

PayPalRESTException