Struct PurchaseUnit

pub struct PurchaseUnit {
    pub reference_id: Option<String>,
    pub amount: Option<AmountWithBreakdown>,
    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>,
}

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

payee: Option<Payee>

The merchant who receives payment for this transaction.

payment_instruction: Option<PaymentInstruction>

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

description: Option<String>

The purchase description.

custom_id: Option<String>

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

invoice_id: Option<String>

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

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

items: Option<Vec<Item>>

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

shipping: Option<ShippingDetail>

The shipping address and method.

payments: Option<PaymentCollection>

The comprehensive history of payments for the purchase unit.

Trait Implementations

impl Clone for PurchaseUnit

fn clone(&self) -> PurchaseUnit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PurchaseUnit

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

Formats the value using the given formatter.

impl Default for PurchaseUnit

fn default() -> PurchaseUnit

Returns the “default value” for a type.

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.