com.paypal.sdk.models

Class PurchaseUnit

java.lang.Object

com.paypal.sdk.models.PurchaseUnit

public class PurchaseUnit
extends Object

This is a model class for PurchaseUnit type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurchaseUnit.Builder Class to build instances of PurchaseUnit.

Constructor Summary

Constructors

Constructor and Description
PurchaseUnit() Default constructor.
PurchaseUnit(String referenceId, AmountWithBreakdown amount, PayeeBase payee, PaymentInstruction paymentInstruction, String description, String customId, String invoiceId, String id, String softDescriptor, List<Item> items, ShippingWithTrackingDetails shipping, SupplementaryData supplementaryData, PaymentCollection payments, List<JsonValue> mostRecentErrors) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
AmountWithBreakdown	getAmount() Getter for Amount.
String	getCustomId() Getter for CustomId.
String	getDescription() Getter for Description.
String	getId() Getter for Id.
String	getInvoiceId() Getter for InvoiceId.
List<Item>	getItems() Getter for Items.
List<JsonValue>	getMostRecentErrors() Getter for MostRecentErrors.
PayeeBase	getPayee() Getter for Payee.
PaymentInstruction	getPaymentInstruction() Getter for PaymentInstruction.
PaymentCollection	getPayments() Getter for Payments.
String	getReferenceId() Getter for ReferenceId.
ShippingWithTrackingDetails	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	setId(String id) Setter for Id.
void	setInvoiceId(String invoiceId) Setter for InvoiceId.
void	setItems(List<Item> items) Setter for Items.
void	setMostRecentErrors(List<JsonValue> mostRecentErrors) Setter for MostRecentErrors.
void	setPayee(PayeeBase payee) Setter for Payee.
void	setPaymentInstruction(PaymentInstruction paymentInstruction) Setter for PaymentInstruction.
void	setPayments(PaymentCollection payments) Setter for Payments.
void	setReferenceId(String referenceId) Setter for ReferenceId.
void	setShipping(ShippingWithTrackingDetails shipping) Setter for Shipping.
void	setSoftDescriptor(String softDescriptor) Setter for SoftDescriptor.
void	setSupplementaryData(SupplementaryData supplementaryData) Setter for SupplementaryData.
PurchaseUnit.Builder	toBuilder() Builds a new PurchaseUnit.Builder object.
String	toString() Converts this PurchaseUnit into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PurchaseUnit

public PurchaseUnit()

Default constructor.

PurchaseUnit

public PurchaseUnit(String referenceId,
                    AmountWithBreakdown amount,
                    PayeeBase payee,
                    PaymentInstruction paymentInstruction,
                    String description,
                    String customId,
                    String invoiceId,
                    String id,
                    String softDescriptor,
                    List<Item> items,
                    ShippingWithTrackingDetails shipping,
                    SupplementaryData supplementaryData,
                    PaymentCollection payments,
                    List<JsonValue> mostRecentErrors)

Initialization constructor.

Parameters:

referenceId - String value for referenceId.

amount - AmountWithBreakdown value for amount.

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.

id - String value for id.

softDescriptor - String value for softDescriptor.

items - List of Item value for items.

shipping - ShippingWithTrackingDetails value for shipping.

supplementaryData - SupplementaryData value for supplementaryData.

payments - PaymentCollection value for payments.

mostRecentErrors - List of JsonValue value for mostRecentErrors.

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`. Note: If there are multiple purchase units, reference_id is required for each purchase unit.

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`. Note: If there are multiple purchase units, reference_id is required for each purchase unit.

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.

Returns:

Returns the String

setDescription

public void setDescription(String description)

Setter for Description. The purchase description.

Parameters:

description - Value for String

getCustomId

public String getCustomId()

Getter for CustomId. The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Returns:

Returns the String

setCustomId

public void setCustomId(String customId)

Setter for CustomId. The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Parameters:

customId - Value for String

getInvoiceId

public String getInvoiceId()

Getter for InvoiceId. The API caller-provided external invoice ID for this order.

Returns:

Returns the String

setInvoiceId

public void setInvoiceId(String invoiceId)

Setter for InvoiceId. The API caller-provided external invoice ID for this order.

Parameters:

invoiceId - Value for String

getId

public String getId()

Getter for Id. The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling v2/checkout/orders/id/save.

Returns:

Returns the String

setId

public void setId(String id)

Setter for Id. The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling v2/checkout/orders/id/save.

Parameters:

id - Value for String

getSoftDescriptor

public String getSoftDescriptor()

Getter for SoftDescriptor. The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters. The soft descriptor supports the following ASCII characters: Alphanumeric characters Dashes Asterisks Periods (.) Spaces For Wallet payments marketplace integrations: The merchant descriptor in the Payment Receiving Preferences must be the marketplace name. You can't use the remaining space to show the customer service number. The remaining spaces can be a combination of seller name and country. For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.

Returns:

Returns the String

setSoftDescriptor

public void setSoftDescriptor(String softDescriptor)

Setter for SoftDescriptor. The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters. The soft descriptor supports the following ASCII characters: Alphanumeric characters Dashes Asterisks Periods (.) Spaces For Wallet payments marketplace integrations: The merchant descriptor in the Payment Receiving Preferences must be the marketplace name. You can't use the remaining space to show the customer service number. The remaining spaces can be a combination of seller name and country. For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.

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 ShippingWithTrackingDetails getShipping()

Getter for Shipping. The order shipping details.

Returns:

Returns the ShippingWithTrackingDetails

setShipping

public void setShipping(ShippingWithTrackingDetails shipping)

Setter for Shipping. The order shipping details.

Parameters:

shipping - Value for ShippingWithTrackingDetails

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

getPayments

public PaymentCollection getPayments()

Getter for Payments. The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.

Returns:

Returns the PaymentCollection

setPayments

public void setPayments(PaymentCollection payments)

Setter for Payments. The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.

Parameters:

payments - Value for PaymentCollection

getMostRecentErrors

public List<JsonValue> getMostRecentErrors()

Getter for MostRecentErrors. The error reason code and description that are the reason for the most recent order decline.

Returns:

Returns the List of JsonValue

setMostRecentErrors

public void setMostRecentErrors(List<JsonValue> mostRecentErrors)

Setter for MostRecentErrors. The error reason code and description that are the reason for the most recent order decline.

Parameters:

mostRecentErrors - Value for List of JsonValue

toString

public String toString()

Converts this PurchaseUnit into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PurchaseUnit.Builder toBuilder()

Builds a new PurchaseUnit.Builder object. Creates the instance with the state of the current model.

Returns:

a new PurchaseUnit.Builder object