StripeAPI.Operations.PostSetupIntents

POST /v1/setup_intents

<p>Creates a SetupIntent object.</p>

<p>After the SetupIntent is created, attach a payment method and <a href="/docs/api/setup_intents/confirm">confirm</a> to collect any required permissions to charge the payment method later.</p>

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostSetupIntentsRequestBody with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.flow_directions.items in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate_data in the specification.

This hash contains details about the Mandate to create. This parameter can only be used with `confirm=true`.

Create a new PostSetupIntentsRequestBodyMandateData' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate_data.properties.customer_acceptance in the specification.

Create a new PostSetupIntentsRequestBodyMandateData'CustomerAcceptance' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate_data.properties.customer_acceptance.properties.online in the specification.

Create a new PostSetupIntentsRequestBodyMandateData'CustomerAcceptance'Online' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate_data.properties.customer_acceptance.properties.type in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data in the specification.

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

Create a new PostSetupIntentsRequestBodyPaymentMethodData' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.acss_debit in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'AcssDebit' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.au_becs_debit in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'AuBecsDebit' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.bacs_debit in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'BacsDebit' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.billing_details in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'BillingDetails' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.billing_details.properties.address.anyOf in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'BillingDetails'Address'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.billing_details.properties.address.anyOf in the specification.

Defines the oneOf schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.billing_details.properties.email.anyOf in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.boleto in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Boleto' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.eps in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Eps' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.eps.properties.bank in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.fpx in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Fpx' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.fpx.properties.bank in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.ideal in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Ideal' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.ideal.properties.bank in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.klarna in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Klarna' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.klarna.properties.dob in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Klarna'Dob' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.p24 in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'P24' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.p24.properties.bank in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.radar_options in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'RadarOptions' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.sepa_debit in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'SepaDebit' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.sofort in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'Sofort' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.sofort.properties.country in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.type in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.us_bank_account in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodData'UsBankAccount' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.us_bank_account.properties.account_holder_type in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.us_bank_account.properties.account_type in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options in the specification.

Payment-method-specific configuration for this SetupIntent.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'AcssDebit' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.currency in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions' with all required fields.

Defines the oneOf schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.custom_mandate_url.anyOf in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.default_for.items in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.payment_schedule in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.transaction_type in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.verification_method in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'Card' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.properties.mandate_options in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'Card'MandateOptions' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.properties.mandate_options.properties.amount_type in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.properties.mandate_options.properties.interval in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.properties.mandate_options.properties.supported_types.items in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.properties.request_three_d_secure in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.link in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'Link' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.sepa_debit in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'SepaDebit' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'UsBankAccount' with all required fields.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.financial_connections in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'UsBankAccount'FinancialConnections' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.financial_connections.properties.permissions.items in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.networks in the specification.

Create a new PostSetupIntentsRequestBodyPaymentMethodOptions'UsBankAccount'Networks' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.networks.properties.requested.items in the specification.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.verification_method in the specification.

Defines the object schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.single_use in the specification.

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

Create a new PostSetupIntentsRequestBodySingleUse' with all required fields.

Defines the enum schema located at paths./v1/setup_intents.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.usage in the specification.

Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.

Represents a response of the operation postSetupIntents.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostSetupIntentsResponseError is used.