com.paypal.api.payments

Class Order

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Order

public class Order
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Order() Default Constructor
Order(Amount amount) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
Authorization	authorize(APIContext apiContext) Authorizes an order, by ID.
Authorization	authorize(java.lang.String accessToken) Deprecated. Please use authorize(APIContext) instead.
protected boolean	canEqual(java.lang.Object other)
Capture	capture(APIContext apiContext, Capture capture) Captures a payment for an order, by ID.
Capture	capture(java.lang.String accessToken, Capture capture) Deprecated. Please use capture(APIContext, Capture) instead.
Order	doVoid(APIContext apiContext) Voids, or cancels, an order, by ID.
Order	doVoid(java.lang.String accessToken) Deprecated. Please use doVoid(APIContext) instead.
boolean	equals(java.lang.Object o)
static Order	get(APIContext apiContext, java.lang.String orderId) Shows details for an order, by ID.
static Order	get(java.lang.String accessToken, java.lang.String orderId) Deprecated. Please use get(APIContext, String) instead.
Amount	getAmount() Amount being collected.
java.lang.String	getCreateTime() Time the resource was created in UTC ISO8601 format.
FmfDetails	getFmfDetails() Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.
java.lang.String	getId() Identifier of the order transaction.
java.util.List<Links>	getLinks()
java.lang.String	getParentPayment() ID of the Payment resource that this transaction is based on.
java.lang.String	getPaymentMode() specifies payment mode of the transaction
java.lang.String	getPendingReason() Deprecated. Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.
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 unit associated with this object.
java.lang.String	getReasonCode() Reason code for the transaction state being Pending or Reversed.
java.lang.String	getReferenceId() Deprecated. Use purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
java.lang.String	getState() State of the order transaction.
java.lang.String	getUpdateTime() Time the resource was last updated in UTC ISO8601 format.
int	hashCode()
Order	setAmount(Amount amount) Amount being collected.
Order	setCreateTime(java.lang.String createTime) Time the resource was created in UTC ISO8601 format.
Order	setFmfDetails(FmfDetails fmfDetails) Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.
Order	setId(java.lang.String id) Identifier of the order transaction.
Order	setLinks(java.util.List<Links> links)
Order	setParentPayment(java.lang.String parentPayment) ID of the Payment resource that this transaction is based on.
Order	setPaymentMode(java.lang.String paymentMode) specifies payment mode of the transaction
Order	setPendingReason(java.lang.String pendingReason) Deprecated. Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.
Order	setProtectionEligibility(java.lang.String protectionEligibility) The level of seller protection in force for the transaction.
Order	setProtectionEligibilityType(java.lang.String protectionEligibilityType) The kind of seller protection in force for the transaction.
Order	setPurchaseUnitReferenceId(java.lang.String purchaseUnitReferenceId) Identifier to the purchase unit associated with this object.
Order	setReasonCode(java.lang.String reasonCode) Reason code for the transaction state being Pending or Reversed.
Order	setReferenceId(java.lang.String referenceId) Deprecated. Use purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
Order	setState(java.lang.String state) State of the order transaction.
Order	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

Order

public Order()

Default Constructor

Order

public Order(Amount amount)

Parameterized Constructor

Method Detail

get

public static Order get(java.lang.String accessToken,
                        java.lang.String orderId)
                 throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Shows details for an order, by ID.

Parameters:

accessToken - Access Token used for the API call.

orderId - String

Returns:

Order

Throws:

PayPalRESTException

get

public static Order get(APIContext apiContext,
                        java.lang.String orderId)
                 throws PayPalRESTException

Shows details for an order, by ID.

Parameters:

apiContext - APIContext used for the API call.

orderId - String

Returns:

Order

Throws:

PayPalRESTException

capture

public Capture capture(java.lang.String accessToken,
                       Capture capture)
                throws PayPalRESTException

Deprecated. Please use capture(APIContext, Capture) instead.

Captures a payment for an order, by ID. To use this call, the original payment call must specify an intent of `order`. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization.

Parameters:

accessToken - Access Token used for the API call.

capture - Capture

Returns:

Capture

Throws:

PayPalRESTException

capture

public Capture capture(APIContext apiContext,
                       Capture capture)
                throws PayPalRESTException

Captures a payment for an order, by ID. To use this call, the original payment call must specify an intent of `order`. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization.

Parameters:

apiContext - APIContext used for the API call.

capture - Capture

Returns:

Capture

Throws:

PayPalRESTException

doVoid

public Order doVoid(java.lang.String accessToken)
             throws PayPalRESTException

Deprecated. Please use doVoid(APIContext) instead.

Voids, or cancels, an order, by ID. You cannot void an order if a payment has already been partially or fully captured.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Order

Throws:

PayPalRESTException

doVoid

public Order doVoid(APIContext apiContext)
             throws PayPalRESTException

Voids, or cancels, an order, by ID. You cannot void an order if a payment has already been partially or fully captured.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Order

Throws:

PayPalRESTException

authorize

public Authorization authorize(java.lang.String accessToken)
                        throws PayPalRESTException

Deprecated. Please use authorize(APIContext) instead.

Authorizes an order, by ID. Include an `amount` object in the JSON request body.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Authorization

Throws:

PayPalRESTException

authorize

public Authorization authorize(APIContext apiContext)
                        throws PayPalRESTException

Authorizes an order, by ID. Include an `amount` object in the JSON request body.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Authorization

Throws:

PayPalRESTException

getId

public java.lang.String getId()

Identifier of the order transaction.

getPurchaseUnitReferenceId

public java.lang.String getPurchaseUnitReferenceId()

Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.

getReferenceId

@Deprecated
public java.lang.String getReferenceId()

Deprecated. Use purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.

getAmount

public Amount getAmount()

Amount being collected.

getPaymentMode

public java.lang.String getPaymentMode()

specifies payment mode of the transaction

getState

public java.lang.String getState()

State of the order transaction.

getReasonCode

public java.lang.String getReasonCode()

Reason code for the transaction state being Pending or Reversed. This field will replace pending_reason field eventually. Only supported when the `payment_method` is set to `paypal`.

getPendingReason

@Deprecated
public java.lang.String getPendingReason()

Deprecated. Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.

getProtectionEligibility

public java.lang.String getProtectionEligibility()

The level of seller protection in force for the transaction.

getProtectionEligibilityType

public java.lang.String getProtectionEligibilityType()

The kind of seller protection in force for the transaction. This property is returned only when the `protection_eligibility` property is set to `ELIGIBLE`or `PARTIALLY_ELIGIBLE`. Only supported when the `payment_method` is set to `paypal`. Allowed values:
`ITEM_NOT_RECEIVED_ELIGIBLE`- Sellers are protected against claims for items not received.
`UNAUTHORIZED_PAYMENT_ELIGIBLE`- Sellers are protected against claims for unauthorized payments.
One or both of the allowed values can be returned.

getParentPayment

public java.lang.String getParentPayment()

ID of the Payment resource that this transaction is based on.

getFmfDetails

public FmfDetails getFmfDetails()

Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.

getCreateTime

public java.lang.String getCreateTime()

Time the resource was created in UTC ISO8601 format.

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 Order setId(java.lang.String id)

Identifier of the order transaction.

Returns:

this

setPurchaseUnitReferenceId

public Order setPurchaseUnitReferenceId(java.lang.String purchaseUnitReferenceId)

Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.

Returns:

this

setReferenceId

@Deprecated
public Order setReferenceId(java.lang.String referenceId)

Deprecated. Use purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.

Returns:

this

setAmount

public Order setAmount(Amount amount)

Amount being collected.

Returns:

this

setPaymentMode

public Order setPaymentMode(java.lang.String paymentMode)

specifies payment mode of the transaction

Returns:

this

setState

public Order setState(java.lang.String state)

State of the order transaction.

Returns:

this

setReasonCode

public Order setReasonCode(java.lang.String reasonCode)

Reason code for the transaction state being Pending or Reversed. This field will replace pending_reason field eventually. Only supported when the `payment_method` is set to `paypal`.

Returns:

this

setPendingReason

@Deprecated
public Order setPendingReason(java.lang.String pendingReason)

Deprecated. Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.

Returns:

this

setProtectionEligibility

public Order setProtectionEligibility(java.lang.String protectionEligibility)

The level of seller protection in force for the transaction.

Returns:

this

setProtectionEligibilityType

public Order setProtectionEligibilityType(java.lang.String protectionEligibilityType)

The kind of seller protection in force for the transaction. This property is returned only when the `protection_eligibility` property is set to `ELIGIBLE`or `PARTIALLY_ELIGIBLE`. Only supported when the `payment_method` is set to `paypal`. Allowed values:
`ITEM_NOT_RECEIVED_ELIGIBLE`- Sellers are protected against claims for items not received.
`UNAUTHORIZED_PAYMENT_ELIGIBLE`- Sellers are protected against claims for unauthorized payments.
One or both of the allowed values can be returned.

Returns:

this

setParentPayment

public Order setParentPayment(java.lang.String parentPayment)

ID of the Payment resource that this transaction is based on.

Returns:

this

setFmfDetails

public Order setFmfDetails(FmfDetails fmfDetails)

Fraud Management Filter (FMF) details applied for the payment that could result in accept/deny/pending action.

Returns:

this

setCreateTime

public Order setCreateTime(java.lang.String createTime)

Time the resource was created in UTC ISO8601 format.

Returns:

this

setUpdateTime

public Order setUpdateTime(java.lang.String updateTime)

Time the resource was last updated in UTC ISO8601 format.

Returns:

this

setLinks

public Order 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