Struct stripe::UpdatePaymentIntent

pub struct UpdatePaymentIntent<'a> {

    pub amount: Option<i64>,
    pub application_fee_amount: Option<i64>,
    pub capture_method: Option<PaymentIntentCaptureMethod>,
    pub currency: Option<Currency>,
    pub customer: Option<CustomerId>,
    pub description: Option<&'a str>,
    pub expand: &'a [&'a str],
    pub metadata: Option<Metadata>,
    pub payment_method: Option<PaymentMethodId>,
    pub payment_method_configuration: Option<PaymentMethodConfigurationId>,
    pub payment_method_data: Option<UpdatePaymentIntentPaymentMethodData>,
    pub payment_method_options: Option<UpdatePaymentIntentPaymentMethodOptions>,
    pub payment_method_types: Option<Vec<String>>,
    pub receipt_email: Option<String>,
    pub setup_future_usage: Option<PaymentIntentSetupFutureUsageFilter>,
    pub shipping: Option<UpdatePaymentIntentShipping>,
    pub statement_descriptor: Option<&'a str>,
    pub statement_descriptor_suffix: Option<&'a str>,
    pub transfer_data: Option<UpdatePaymentIntentTransferData>,
    pub transfer_group: Option<&'a str>,
}

The parameters for PaymentIntent::update.

Fields

amount: Option<i64>

Amount intended to be collected by this PaymentIntent.

A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

application_fee_amount: Option<i64>

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account.

The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

capture_method: Option<PaymentIntentCaptureMethod>

Controls when the funds will be captured from the customer’s account.

currency: Option<Currency>

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

customer: Option<CustomerId>

ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If present in combination with setup_future_usage, this PaymentIntent’s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

description: Option<&'a str>

An arbitrary string attached to the object.

Often useful for displaying to users.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

metadata: Option<Metadata>

Set of key-value pairs that you can attach to an object.

This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

payment_method: Option<PaymentMethodId>

ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.

payment_method_configuration: Option<PaymentMethodConfigurationId>

The ID of the payment method configuration to use with this PaymentIntent.

payment_method_data: Option<UpdatePaymentIntentPaymentMethodData>

If provided, this hash will be used to create a PaymentMethod.

The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

payment_method_options: Option<UpdatePaymentIntentPaymentMethodOptions>

Payment-method-specific configuration for this PaymentIntent.

payment_method_types: Option<Vec<String>>

The list of payment method types (for example, card) that this PaymentIntent can use.

Use automatic_payment_methods to manage payment methods from the Stripe Dashboard.

receipt_email: Option<String>

Email address that the receipt for the resulting payment will be sent to.

If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

setup_future_usage: Option<PaymentIntentSetupFutureUsageFilter>

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

Providing this parameter will attach the payment method to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.

If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes. When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA. If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.

shipping: Option<UpdatePaymentIntentShipping>

Shipping information for this PaymentIntent.

statement_descriptor: Option<&'a str>

For card charges, use statement_descriptor_suffix.

Otherwise, you can use this value as the complete description of a charge on your customers’ statements. It must contain at least one letter and be 1–22 characters long.

statement_descriptor_suffix: Option<&'a str>

Provides information about a card payment that customers see on their statements.

Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.

transfer_data: Option<UpdatePaymentIntentTransferData>

Use this parameter to automatically create a Transfer when the payment succeeds.

Learn more about the use case for connected accounts.

transfer_group: Option<&'a str>

A string that identifies the resulting payment as part of a group.

You can only provide transfer_group if it hasn’t been set. Learn more about the use case for connected accounts.

Implementations

impl<'a> UpdatePaymentIntent<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdatePaymentIntent<'a>

fn clone(&self) -> UpdatePaymentIntent<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdatePaymentIntent<'a>

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

Formats the value using the given formatter.

impl<'a> Default for UpdatePaymentIntent<'a>

fn default() -> UpdatePaymentIntent<'a>

Returns the “default value” for a type.

impl<'a> Serialize for UpdatePaymentIntent<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.