Struct paypal_rs::orders::PurchaseUnit

pub struct PurchaseUnit {
    pub reference_id: Option<String>,
    pub amount: Amount,
    pub payee: Option<Payee>,
    pub payment_instruction: Option<PaymentInstruction>,
    pub description: Option<String>,
    pub custom_id: Option<String>,
    pub invoice_id: Option<String>,
    pub id: Option<String>,
    pub soft_descriptor: Option<String>,
    pub items: Option<Vec<Item>>,
    pub shipping: Option<ShippingDetail>,
    pub payments: Option<PaymentCollection>,
}

Represents either a full or partial order that the payer intends to purchase from the payee.

Fields

reference_id: Option<String>

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.

amount: 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.

payee: Option<Payee>

The merchant who receives payment for this transaction.

payment_instruction: Option<PaymentInstruction>

Any additional payment instructions for PayPal Commerce Platform customers. Enables features for the PayPal Commerce Platform, such as delayed disbursement and collection of a platform fee. Applies during order creation for captured payments or during capture of authorized payments.

description: Option<String>

The purchase description.

custom_id: Option<String>

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.

invoice_id: Option<String>

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.

id: Option<String>

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.

soft_descriptor: Option<String>

The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.

More info here: https://developer.paypal.com/docs/api/orders/v2/#definition-purchase_unit_request

items: Option<Vec<Item>>

An array of items that the customer purchases from the merchant.

shipping: Option<ShippingDetail>

The name and address of the person to whom to ship the items.

payments: Option<PaymentCollection>

The comprehensive history of payments for the purchase unit.

Implementations

impl PurchaseUnit

pub fn new(amount: Amount) -> Self

Creates a new PurchaseUnit with the required properties.

Trait Implementations

impl Debug for PurchaseUnit

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PurchaseUnit

pub fn default() -> PurchaseUnit

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PurchaseUnit

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for PurchaseUnit

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.