Struct stripe::generated::core::setup_intent::CreateSetupIntent

pub struct CreateSetupIntent<'a> {

    pub attach_to_self: Option<bool>,
    pub automatic_payment_methods: Option<CreateSetupIntentAutomaticPaymentMethods>,
    pub confirm: Option<bool>,
    pub customer: Option<CustomerId>,
    pub description: Option<&'a str>,
    pub expand: &'a [&'a str],
    pub flow_directions: Option<Vec<CreateSetupIntentFlowDirections>>,
    pub mandate_data: Option<CreateSetupIntentMandateData>,
    pub metadata: Option<Metadata>,
    pub on_behalf_of: Option<&'a str>,
    pub payment_method: Option<PaymentMethodId>,
    pub payment_method_configuration: Option<PaymentMethodConfigurationId>,
    pub payment_method_data: Option<CreateSetupIntentPaymentMethodData>,
    pub payment_method_options: Option<CreateSetupIntentPaymentMethodOptions>,
    pub payment_method_types: Option<Vec<String>>,
    pub return_url: Option<&'a str>,
    pub single_use: Option<CreateSetupIntentSingleUse>,
    pub use_stripe_sdk: Option<bool>,
}

The parameters for SetupIntent::create.

Fields

attach_to_self: Option<bool>

If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers.

It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

automatic_payment_methods: Option<CreateSetupIntentAutomaticPaymentMethods>

When enabled, this SetupIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this SetupIntent’s other parameters.

confirm: Option<bool>

Set to true to attempt to confirm this SetupIntent immediately.

This parameter defaults to false. If the payment method attached is a card, a return_url may be provided in case additional authentication is required.

customer: Option<CustomerId>

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

If present, the SetupIntent’s payment method will be attached to the Customer on successful setup.

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

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.

flow_directions: Option<Vec<CreateSetupIntentFlowDirections>>

Indicates the directions of money movement for which this payment method is intended to be used.

Include inbound if you intend to use the payment method as the origin to pull funds from.

Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

mandate_data: Option<CreateSetupIntentMandateData>

This hash contains details about the Mandate to create.

This parameter can only be used with confirm=true.

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.

on_behalf_of: Option<&'a str>

The Stripe account ID for which this SetupIntent is created.

payment_method: Option<PaymentMethodId>

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

payment_method_configuration: Option<PaymentMethodConfigurationId>

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

payment_method_data: Option<CreateSetupIntentPaymentMethodData>

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

payment_method_options: Option<CreateSetupIntentPaymentMethodOptions>

Payment-method-specific configuration for this SetupIntent.

payment_method_types: Option<Vec<String>>

The list of payment method types (e.g.

card) that this SetupIntent is allowed to use. If this is not provided, defaults to [“card”].

return_url: Option<&'a str>

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 can only be used with confirm=true.

single_use: Option<CreateSetupIntentSingleUse>

If this hash is populated, this SetupIntent will generate a single_use Mandate on success.

use_stripe_sdk: Option<bool>

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

Implementations

impl<'a> CreateSetupIntent<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for CreateSetupIntent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateSetupIntent<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CreateSetupIntent<'a>

fn default() -> CreateSetupIntent<'a>

Returns the “default value” for a type.

impl<'a> Serialize for CreateSetupIntent<'a>

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

Serialize this value into the given Serde serializer.