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

Class OrderRequest

java.lang.Object
com.broadleafcommerce.paypal.micro.gateway.domain.orders.OrderRequest
All Implemented Interfaces:
Serializable
public class OrderRequest extends Object implements Serializable
The request to create the PayPal order.
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • OrderRequest

      public OrderRequest()

  • Method Details

    • setCheckoutPaymentIntent

      public void setCheckoutPaymentIntent(String checkoutPaymentIntent)
      The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are:
      • "CAPTURE". The merchant intends to capture payment immediately after the customer makes a payment.
      • "AUTHORIZE". The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.

    • setPurchaseUnits

      public void setPurchaseUnits(List<PurchaseUnit> purchaseUnits)
      An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.

    • setPaymentSource

      public void setPaymentSource(PaymentSource paymentSource)
      The payment source used to fund the payment.

    • getCheckoutPaymentIntent

      public String getCheckoutPaymentIntent()
      The intent to either capture payment immediately or authorize a payment for an order after order creation. The possible values are:
      • "CAPTURE". The merchant intends to capture payment immediately after the customer makes a payment.
      • "AUTHORIZE". The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.

    • getPurchaseUnits

      public List<PurchaseUnit> getPurchaseUnits()
      An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.

    • getPaymentSource

      public PaymentSource getPaymentSource()
      The payment source used to fund the payment.