Struct PurchaseUnitRequest

pub struct PurchaseUnitRequest {
    pub reference_ids: Option<String>,
    pub amount: 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 soft_descriptor: Option<String>,
    pub items: Vec<Item>,
    pub shipping: Option<ShippingDetail>,
}

Fields

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

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.

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.

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

Implementations

impl PurchaseUnitRequest

pub const fn new(amount: AmountWithBreakdown) -> Self

pub fn reference_ids(&mut self, reference_ids: String) -> &mut Self

pub fn amount(&mut self, amount: AmountWithBreakdown) -> &mut Self

pub fn payee(&mut self, payee: Payee) -> &mut Self

pub fn payment_instruction( &mut self, payment_instruction: PaymentInstruction, ) -> &mut Self

pub fn description(&mut self, description: String) -> &mut Self

pub fn custom_id(&mut self, custom_id: String) -> &mut Self

pub fn invoice_id(&mut self, invoice_id: String) -> &mut Self

pub fn soft_descriptor(&mut self, soft_descriptor: String) -> &mut Self

pub fn items(&mut self, items: Vec<Item>) -> &mut Self

pub fn shipping(&mut self, shipping: ShippingDetail) -> &mut Self

Trait Implementations

impl Clone for PurchaseUnitRequest

fn clone(&self) -> PurchaseUnitRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PurchaseUnitRequest

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

Formats the value using the given formatter.

impl Default for PurchaseUnitRequest

fn default() -> PurchaseUnitRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PurchaseUnitRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PurchaseUnitRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.