Order (REST API SDK 1.6.0 API)

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

All Implemented Interfaces:

Serializable
```
public class Order
extends PayPalResource
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Order()
Default Constructor

Order(Amount amount)
Parameterized Constructor

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authorization`	`authorize(APIContext apiContext)` Creates an authorization on an order
`Authorization`	`authorize(String accessToken)` Creates an authorization on an order
`Capture`	`capture(APIContext apiContext, Capture capture)` Creates (and processes) a new Capture Transaction added as a related resource.
`Capture`	`capture(String accessToken, Capture capture)` Creates (and processes) a new Capture Transaction added as a related resource.
`Order`	`doVoid(APIContext apiContext)` Voids (cancels) an Order.
`Order`	`doVoid(String accessToken)` Voids (cancels) an Order.
`static Order`	`get(APIContext apiContext, String orderId)` Obtain the Order resource for the given identifier.
`static Order`	`get(String accessToken, String orderId)` Obtain the Order resource for the given identifier.
`Amount`	`getAmount()` Getter for amount
`String`	`getCreateTime()` Getter for createTime
`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
`String`	`getPaymentMode()` Getter for paymentMode
`String`	`getPendingReason()` Getter for pendingReason
`String`	`getProtectionEligibility()` Getter for protectionEligibility
`String`	`getProtectionEligibilityType()` Getter for protectionEligibilityType
`String`	`getPurchaseUnitReferenceId()` Getter for purchaseUnitReferenceId
`String`	`getReasonCode()` Getter for reasonCode
`String`	`getState()` Getter for state
`String`	`getUpdateTime()` Getter for updateTime
`Order`	`setAmount(Amount amount)` Setter for amount
`Order`	`setCreateTime(String createTime)` Setter for createTime
`Order`	`setFmfDetails(FmfDetails fmfDetails)` Setter for fmfDetails
`Order`	`setId(String id)` Setter for id
`Order`	`setLinks(List<Links> links)` Setter for links
`Order`	`setParentPayment(String parentPayment)` Setter for parentPayment
`Order`	`setPaymentMode(String paymentMode)` Setter for paymentMode
`Order`	`setPendingReason(String pendingReason)` Setter for pendingReason
`Order`	`setProtectionEligibility(String protectionEligibility)` Setter for protectionEligibility
`Order`	`setProtectionEligibilityType(String protectionEligibilityType)` Setter for protectionEligibilityType
`Order`	`setPurchaseUnitReferenceId(String purchaseUnitReferenceId)` Setter for purchaseUnitReferenceId
`Order`	`setReasonCode(String reasonCode)` Setter for reasonCode
`Order`	`setState(String state)` Setter for state
`Order`	`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
  - Order
```
public Order()
```
    Default Constructor
  - Order
```
public Order(Amount amount)
```
    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 Order setId(String id)
```
    Setter for id
  - getId
```
public String getId()
```
    Getter for id
  - setPurchaseUnitReferenceId
```
public Order setPurchaseUnitReferenceId(String purchaseUnitReferenceId)
```
    Setter for purchaseUnitReferenceId
  - getPurchaseUnitReferenceId
```
public String getPurchaseUnitReferenceId()
```
    Getter for purchaseUnitReferenceId
  - setAmount
```
public Order setAmount(Amount amount)
```
    Setter for amount
  - getAmount
```
public Amount getAmount()
```
    Getter for amount
  - setPaymentMode
```
public Order setPaymentMode(String paymentMode)
```
    Setter for paymentMode
  - getPaymentMode
```
public String getPaymentMode()
```
    Getter for paymentMode
  - setState
```
public Order setState(String state)
```
    Setter for state
  - getState
```
public String getState()
```
    Getter for state
  - setReasonCode
```
public Order setReasonCode(String reasonCode)
```
    Setter for reasonCode
  - getReasonCode
```
public String getReasonCode()
```
    Getter for reasonCode
  - setPendingReason
```
public Order setPendingReason(String pendingReason)
```
    Setter for pendingReason
  - getPendingReason
```
public String getPendingReason()
```
    Getter for pendingReason
  - setProtectionEligibility
```
public Order setProtectionEligibility(String protectionEligibility)
```
    Setter for protectionEligibility
  - getProtectionEligibility
```
public String getProtectionEligibility()
```
    Getter for protectionEligibility
  - setProtectionEligibilityType
```
public Order setProtectionEligibilityType(String protectionEligibilityType)
```
    Setter for protectionEligibilityType
  - getProtectionEligibilityType
```
public String getProtectionEligibilityType()
```
    Getter for protectionEligibilityType
  - setParentPayment
```
public Order setParentPayment(String parentPayment)
```
    Setter for parentPayment
  - getParentPayment
```
public String getParentPayment()
```
    Getter for parentPayment
  - setFmfDetails
```
public Order setFmfDetails(FmfDetails fmfDetails)
```
    Setter for fmfDetails
  - getFmfDetails
```
public FmfDetails getFmfDetails()
```
    Getter for fmfDetails
  - setCreateTime
```
public Order setCreateTime(String createTime)
```
    Setter for createTime
  - getCreateTime
```
public String getCreateTime()
```
    Getter for createTime
  - setUpdateTime
```
public Order setUpdateTime(String updateTime)
```
    Setter for updateTime
  - getUpdateTime
```
public String getUpdateTime()
```
    Getter for updateTime
  - setLinks
```
public Order setLinks(List<Links> links)
```
    Setter for links
  - getLinks
```
public List<Links> getLinks()
```
    Getter for links
  - get
```
public static Order get(String accessToken,
                        String orderId)
                 throws PayPalRESTException
```
    Obtain the Order resource for the given identifier.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    orderId - String
    
    Returns:
    
    Order
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Order get(APIContext apiContext,
                        String orderId)
                 throws PayPalRESTException
```
    Obtain the Order resource for the given identifier.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    orderId - String
    
    Returns:
    
    Order
    
    Throws:
    
    PayPalRESTException
  - capture
```
public Capture capture(String accessToken,
                       Capture capture)
                throws PayPalRESTException
```
    Creates (and processes) a new Capture Transaction added as a related resource.
    
    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
```
    Creates (and processes) a new Capture Transaction added as a related resource.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    capture - Capture
    
    Returns:
    
    Capture
    
    Throws:
    
    PayPalRESTException
  - doVoid
```
public Order doVoid(String accessToken)
             throws PayPalRESTException
```
    Voids (cancels) an Order.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Returns:
    
    Order
    
    Throws:
    
    PayPalRESTException
  - doVoid
```
public Order doVoid(APIContext apiContext)
             throws PayPalRESTException
```
    Voids (cancels) an Order.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Order
    
    Throws:
    
    PayPalRESTException
  - authorize
```
public Authorization authorize(String accessToken)
                        throws PayPalRESTException
```
    Creates an authorization on an order
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Returns:
    
    Authorization
    
    Throws:
    
    PayPalRESTException
  - authorize
```
public Authorization authorize(APIContext apiContext)
                        throws PayPalRESTException
```
    Creates an authorization on an order
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Authorization
    
    Throws:
    
    PayPalRESTException

Class Order

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

Order

Order

Method Detail

getLastRequest

getLastResponse

setId

getId

setPurchaseUnitReferenceId

getPurchaseUnitReferenceId

setAmount

getAmount

setPaymentMode

getPaymentMode

setState

getState

setReasonCode

getReasonCode

setPendingReason

getPendingReason

setProtectionEligibility

getProtectionEligibility

setProtectionEligibilityType

getProtectionEligibilityType

setParentPayment

getParentPayment

setFmfDetails

getFmfDetails

setCreateTime

getCreateTime

setUpdateTime

getUpdateTime

setLinks

getLinks

get

get

capture

capture

doVoid

doVoid

authorize

authorize