PurchaseUnitRequest (PayPal Server SDK 1.0.0 API)

java.lang.Object
- com.paypal.sdk.models.PurchaseUnitRequest

```
public class PurchaseUnitRequest
extends Object
```
This is a model class for PurchaseUnitRequest type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PurchaseUnitRequest.Builder
Class to build instances of PurchaseUnitRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PurchaseUnitRequest.Builder` Class to build instances of `PurchaseUnitRequest`.

Constructor Summary

Constructors
Constructor and Description
`PurchaseUnitRequest()` Default constructor.
`PurchaseUnitRequest(AmountWithBreakdown amount, String referenceId, PayeeBase payee, PaymentInstruction paymentInstruction, String description, String customId, String invoiceId, String softDescriptor, List<Item> items, ShippingDetails shipping, SupplementaryData supplementaryData)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmountWithBreakdown`	`getAmount()` Getter for Amount.
`String`	`getCustomId()` Getter for CustomId.
`String`	`getDescription()` Getter for Description.
`String`	`getInvoiceId()` Getter for InvoiceId.
`List<Item>`	`getItems()` Getter for Items.
`PayeeBase`	`getPayee()` Getter for Payee.
`PaymentInstruction`	`getPaymentInstruction()` Getter for PaymentInstruction.
`String`	`getReferenceId()` Getter for ReferenceId.
`ShippingDetails`	`getShipping()` Getter for Shipping.
`String`	`getSoftDescriptor()` Getter for SoftDescriptor.
`SupplementaryData`	`getSupplementaryData()` Getter for SupplementaryData.
`void`	`setAmount(AmountWithBreakdown amount)` Setter for Amount.
`void`	`setCustomId(String customId)` Setter for CustomId.
`void`	`setDescription(String description)` Setter for Description.
`void`	`setInvoiceId(String invoiceId)` Setter for InvoiceId.
`void`	`setItems(List<Item> items)` Setter for Items.
`void`	`setPayee(PayeeBase payee)` Setter for Payee.
`void`	`setPaymentInstruction(PaymentInstruction paymentInstruction)` Setter for PaymentInstruction.
`void`	`setReferenceId(String referenceId)` Setter for ReferenceId.
`void`	`setShipping(ShippingDetails shipping)` Setter for Shipping.
`void`	`setSoftDescriptor(String softDescriptor)` Setter for SoftDescriptor.
`void`	`setSupplementaryData(SupplementaryData supplementaryData)` Setter for SupplementaryData.
`PurchaseUnitRequest.Builder`	`toBuilder()` Builds a new `PurchaseUnitRequest.Builder` object.
`String`	`toString()` Converts this PurchaseUnitRequest into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PurchaseUnitRequest
```
public PurchaseUnitRequest()
```
    Default constructor.
  - PurchaseUnitRequest
```
public PurchaseUnitRequest(AmountWithBreakdown amount,
                           String referenceId,
                           PayeeBase payee,
                           PaymentInstruction paymentInstruction,
                           String description,
                           String customId,
                           String invoiceId,
                           String softDescriptor,
                           List<Item> items,
                           ShippingDetails shipping,
                           SupplementaryData supplementaryData)
```
    Initialization constructor.
    
    Parameters:
    
    amount - AmountWithBreakdown value for amount.
    
    referenceId - String value for referenceId.
    
    payee - PayeeBase value for payee.
    
    paymentInstruction - PaymentInstruction value for paymentInstruction.
    
    description - String value for description.
    
    customId - String value for customId.
    
    invoiceId - String value for invoiceId.
    
    softDescriptor - String value for softDescriptor.
    
    items - List of Item value for items.
    
    shipping - ShippingDetails value for shipping.
    
    supplementaryData - SupplementaryData value for supplementaryData.
- Method Detail
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through `PATCH`. If you omit this value and the order contains only one purchase unit, PayPal sets this value to `default`.
    
    Returns:
    
    Returns the String
  - setReferenceId
```
public void setReferenceId(String referenceId)
```
    Setter for ReferenceId. The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through `PATCH`. If you omit this value and the order contains only one purchase unit, PayPal sets this value to `default`.
    
    Parameters:
    
    referenceId - Value for String
  - getAmount
```
public AmountWithBreakdown getAmount()
```
    Getter for Amount. The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling` plus `insurance` minus `shipping_discount` minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
    
    Returns:
    
    Returns the AmountWithBreakdown
  - setAmount
```
public void setAmount(AmountWithBreakdown amount)
```
    Setter for Amount. The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling` plus `insurance` minus `shipping_discount` minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
    
    Parameters:
    
    amount - Value for AmountWithBreakdown
  - getPayee
```
public PayeeBase getPayee()
```
    Getter for Payee. The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
    
    Returns:
    
    Returns the PayeeBase
  - setPayee
```
public void setPayee(PayeeBase payee)
```
    Setter for Payee. The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
    
    Parameters:
    
    payee - Value for PayeeBase
  - getPaymentInstruction
```
public PaymentInstruction getPaymentInstruction()
```
    Getter for PaymentInstruction. Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
    
    Returns:
    
    Returns the PaymentInstruction
  - setPaymentInstruction
```
public void setPaymentInstruction(PaymentInstruction paymentInstruction)
```
    Setter for PaymentInstruction. Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
    
    Parameters:
    
    paymentInstruction - Value for PaymentInstruction
  - getDescription
```
public String getDescription()
```
    Getter for Description. The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.
    
    Returns:
    
    Returns the String
  - setDescription
```
public void setDescription(String description)
```
    Setter for Description. The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.
    
    Parameters:
    
    description - Value for String
  - getCustomId
```
public String getCustomId()
```
    Getter for CustomId. The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.
    
    Returns:
    
    Returns the String
  - setCustomId
```
public void setCustomId(String customId)
```
    Setter for CustomId. The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.
    
    Parameters:
    
    customId - Value for String
  - getInvoiceId
```
public String getInvoiceId()
```
    Getter for InvoiceId. The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
    
    Returns:
    
    Returns the String
  - setInvoiceId
```
public void setInvoiceId(String invoiceId)
```
    Setter for InvoiceId. The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
    
    Parameters:
    
    invoiceId - Value for String
  - getSoftDescriptor
```
public String getSoftDescriptor()
```
    Getter for SoftDescriptor. The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement. If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. For example, if: The PayPal prefix toggle is PAYPAL *. The merchant descriptor in the profile is Janes Gift. The soft descriptor is 800-123-1234. Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.
    
    Returns:
    
    Returns the String
  - setSoftDescriptor
```
public void setSoftDescriptor(String softDescriptor)
```
    Setter for SoftDescriptor. The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement. If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. For example, if: The PayPal prefix toggle is PAYPAL *. The merchant descriptor in the profile is Janes Gift. The soft descriptor is 800-123-1234. Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.
    
    Parameters:
    
    softDescriptor - Value for String
  - getItems
```
public List<Item> getItems()
```
    Getter for Items. An array of items that the customer purchases from the merchant.
    
    Returns:
    
    Returns the List of Item
  - setItems
```
public void setItems(List<Item> items)
```
    Setter for Items. An array of items that the customer purchases from the merchant.
    
    Parameters:
    
    items - Value for List of Item
  - getShipping
```
public ShippingDetails getShipping()
```
    Getter for Shipping. The shipping details.
    
    Returns:
    
    Returns the ShippingDetails
  - setShipping
```
public void setShipping(ShippingDetails shipping)
```
    Setter for Shipping. The shipping details.
    
    Parameters:
    
    shipping - Value for ShippingDetails
  - getSupplementaryData
```
public SupplementaryData getSupplementaryData()
```
    Getter for SupplementaryData. Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data.
    
    Returns:
    
    Returns the SupplementaryData
  - setSupplementaryData
```
public void setSupplementaryData(SupplementaryData supplementaryData)
```
    Setter for SupplementaryData. Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data.
    
    Parameters:
    
    supplementaryData - Value for SupplementaryData
  - toString
```
public String toString()
```
    Converts this PurchaseUnitRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public PurchaseUnitRequest.Builder toBuilder()
```
    Builds a new PurchaseUnitRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new PurchaseUnitRequest.Builder object

Class PurchaseUnitRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PurchaseUnitRequest

PurchaseUnitRequest

Method Detail

getReferenceId

setReferenceId

getAmount

setAmount

getPayee

setPayee

getPaymentInstruction

setPaymentInstruction

getDescription

setDescription

getCustomId

setCustomId

getInvoiceId

setInvoiceId

getSoftDescriptor

setSoftDescriptor

getItems

setItems

getShipping

setShipping

getSupplementaryData

setSupplementaryData

toString

toBuilder