Struct ConfirmPaymentIntent

pub struct ConfirmPaymentIntent { /* private fields */ }

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.

Implementations

impl ConfirmPaymentIntent

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

Construct a new ConfirmPaymentIntent.

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 confirmation_token(self, confirmation_token: impl Into<String>) -> Self

ID of the ConfirmationToken used to confirm this PaymentIntent.

If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

pub fn error_on_requires_action( self, error_on_requires_action: impl Into<bool>, ) -> Self

Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.

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

Specifies which fields in the response should be expanded.

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

ID of the mandate that’s used for this payment.

pub fn mandate_data( self, mandate_data: impl Into<ConfirmPaymentIntentMandateData>, ) -> Self

pub fn off_session( self, off_session: impl Into<ConfirmPaymentIntentOffSession>, ) -> Self

Set to true to indicate that the customer isn’t in your checkout flow during this payment attempt and can’t authenticate. Use this parameter in scenarios where you collect card details and charge them later.

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.

pub fn payment_method_data( self, payment_method_data: impl Into<ConfirmPaymentIntentPaymentMethodData>, ) -> 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<ConfirmPaymentIntentPaymentMethodOptions>, ) -> 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, a card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard.

pub fn radar_options( self, radar_options: impl Into<RadarOptionsWithHiddenOptions>, ) -> Self

Options to configure Radar. Learn more about Radar Sessions.

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 return_url(self, return_url: impl Into<String>) -> Self

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

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<ConfirmPaymentIntentShipping>) -> Self

Shipping information for this PaymentIntent.

pub fn use_stripe_sdk(self, use_stripe_sdk: impl Into<bool>) -> Self

Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

impl ConfirmPaymentIntent

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 ConfirmPaymentIntent

fn clone(&self) -> ConfirmPaymentIntent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfirmPaymentIntent

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

Formats the value using the given formatter.

impl Serialize for ConfirmPaymentIntent

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 ConfirmPaymentIntent

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.