Struct ConfirmSetupIntent 

pub struct ConfirmSetupIntent { /* private fields */ }

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

Implementations

impl ConfirmSetupIntent

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

Construct a new ConfirmSetupIntent.

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

ID of the ConfirmationToken used to confirm this SetupIntent.

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

Specifies which fields in the response should be expanded.

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

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

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

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

When included, this hash creates a PaymentMethod that is set as the payment_method. value in the SetupIntent.

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

Payment method-specific configuration for this SetupIntent.

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

The URL to redirect your customer back to after they authenticate 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 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 ConfirmSetupIntent

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 ConfirmSetupIntent

fn clone(&self) -> ConfirmSetupIntent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfirmSetupIntent

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

Formats the value using the given formatter.

impl Serialize for ConfirmSetupIntent

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 ConfirmSetupIntent

type Output = SetupIntent

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.