Struct UpdatePaymentIntent

pub struct UpdatePaymentIntent { /* private fields */ }

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Implementations

impl UpdatePaymentIntent

pub fn new(intent: impl Into<PaymentIntentId>) -> Self

Construct a new UpdatePaymentIntent.

pub fn amount(self, amount: impl Into<i64>) -> Self

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

pub fn application_fee_amount( self, application_fee_amount: impl Into<i64>, ) -> Self

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 amount captured. For more information, see the PaymentIntents use case for connected accounts.

pub fn capture_method( self, capture_method: impl Into<PaymentIntentCaptureMethod>, ) -> Self

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

pub fn currency(self, currency: impl Into<Currency>) -> Self

Three-letter ISO currency code, in lowercase. Must be a supported currency.

pub fn customer(self, customer: impl Into<String>) -> Self

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

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

If setup_future_usage is set and this PaymentIntent’s payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn’t a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

pub fn description(self, description: impl Into<String>) -> Self

An arbitrary string attached to the object. Often useful for displaying to users.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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.

pub fn payment_method(self, payment_method: impl Into<String>) -> Self

ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.

pub fn payment_method_configuration( self, payment_method_configuration: impl Into<String>, ) -> Self

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

pub fn payment_method_data( self, payment_method_data: impl Into<UpdatePaymentIntentPaymentMethodData>, ) -> Self

If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method. property on the PaymentIntent.

pub fn payment_method_options( self, payment_method_options: impl Into<UpdatePaymentIntentPaymentMethodOptions>, ) -> Self

Payment-method-specific configuration for this PaymentIntent.

pub fn payment_method_types( self, payment_method_types: impl Into<Vec<String>>, ) -> Self

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.

pub fn receipt_email(self, receipt_email: impl Into<String>) -> Self

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.

pub fn setup_future_usage( self, setup_future_usage: impl Into<PaymentIntentSetupFutureUsage>, ) -> Self

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

If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

pub fn shipping(self, shipping: impl Into<UpdatePaymentIntentShipping>) -> Self

Shipping information for this PaymentIntent.

pub fn statement_descriptor( self, statement_descriptor: impl Into<String>, ) -> Self

Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

pub fn statement_descriptor_suffix( self, statement_descriptor_suffix: impl Into<String>, ) -> Self

Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

pub fn transfer_data( self, transfer_data: impl Into<UpdatePaymentIntentTransferData>, ) -> Self

Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the use case for connected accounts.

pub fn transfer_group(self, transfer_group: impl Into<String>) -> Self

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.

impl UpdatePaymentIntent

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for UpdatePaymentIntent

fn clone(&self) -> UpdatePaymentIntent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdatePaymentIntent

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

Formats the value using the given formatter.

impl Serialize for UpdatePaymentIntent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for UpdatePaymentIntent

type Output = PaymentIntent

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.