Package com.broadleafcommerce.paypal.micro.gateway.domain.orders

Class PurchaseUnit

java.lang.Object
com.broadleafcommerce.paypal.micro.gateway.domain.orders.PurchaseUnit
All Implemented Interfaces:
Serializable
public class PurchaseUnit extends Object implements Serializable
The purchase unit details. Used to capture required information for the payment contract.
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • PurchaseUnit

      public PurchaseUnit()

  • Method Details

    • setId

      public void setId(String 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".

    • setAmountWithBreakdown

      public void setAmountWithBreakdown(AmountWithBreakdown amountWithBreakdown)
      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.

    • setCustomId

      public void setCustomId(String customId)
      The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

    • setDescription

      public void setDescription(String description)
      The purchase description.

    • setInvoiceId

      public void setInvoiceId(String invoiceId)
      The API caller-provided external invoice ID for this order.

    • setItems

      public void setItems(List<Item> items)
      An array of items that the customer purchases from the merchant.

    • setPayee

      public void setPayee(Payee payee)
      The merchant who receives payment for this transaction.

    • setPaymentInstruction

      public void setPaymentInstruction(PaymentInstruction paymentInstruction)
      Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

    • setPayments

      public void setPayments(PaymentCollection payments)
      The comprehensive history of payments for the purchase unit.

    • setReferenceId

      public void setReferenceId(String 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".

    • setShippingDetail

      public void setShippingDetail(ShippingDetail shippingDetail)
      The name and address of the person to whom to ship the items.

    • setSoftDescriptor

      public void setSoftDescriptor(String 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.

    • getId

      public String getId()
      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".

    • getAmountWithBreakdown

      public AmountWithBreakdown getAmountWithBreakdown()
      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.

    • getCustomId

      public String getCustomId()
      The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

    • getDescription

      public String getDescription()
      The purchase description.

    • getInvoiceId

      public String getInvoiceId()
      The API caller-provided external invoice ID for this order.

    • getItems

      public List<Item> getItems()
      An array of items that the customer purchases from the merchant.

    • getPayee

      public Payee getPayee()
      The merchant who receives payment for this transaction.

    • getPaymentInstruction

      public PaymentInstruction getPaymentInstruction()
      Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

    • getPayments

      public PaymentCollection getPayments()
      The comprehensive history of payments for the purchase unit.

    • getReferenceId

      public String getReferenceId()
      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".

    • getShippingDetail

      public ShippingDetail getShippingDetail()
      The name and address of the person to whom to ship the items.

    • getSoftDescriptor

      public String getSoftDescriptor()
      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.