StripeAPI.Operations.PostSetupIntentsIntentConfirm

POST /v1/setup_intents/{intent}/confirm

<p>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.</p>

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

<p>Otherwise, it will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If setup fails, the SetupIntent will transition to the <code>requires_payment_method</code> status.</p>

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

Create a new PostSetupIntentsIntentConfirmRequestBody with all required fields.

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

This hash contains details about the Mandate to create

Create a new PostSetupIntentsIntentConfirmRequestBodyMandateData' with all required fields.

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

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

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

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

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

Defines the object schema located at paths./v1/setup_intents/{intent}/confirm.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 PostSetupIntentsIntentConfirmRequestBodyPaymentMethodData' with all required fields.

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

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

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

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

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

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

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

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

Defines the object schema located at paths./v1/setup_intents/{intent}/confirm.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 PostSetupIntentsIntentConfirmRequestBodyPaymentMethodData'BillingDetails'Address'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.boleto in the specification.

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

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

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.fpx in the specification.

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.ideal in the specification.

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.klarna in the specification.

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

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

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

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

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.radar_options in the specification.

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

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

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

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

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_data.properties.us_bank_account in the specification.

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.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 PostSetupIntentsIntentConfirmRequestBodyPaymentMethodOptions' with all required fields.

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

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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 PostSetupIntentsIntentConfirmRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions' with all required fields.

Defines the oneOf schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card in the specification.

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

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

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

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.link in the specification.

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

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

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

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

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

Defines the object schema located at paths./v1/setup_intents/{intent}/confirm.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 PostSetupIntentsIntentConfirmRequestBodyPaymentMethodOptions'UsBankAccount'FinancialConnections' with all required fields.

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.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 PostSetupIntentsIntentConfirmRequestBodyPaymentMethodOptions'UsBankAccount'Networks' with all required fields.

Defines the enum schema located at paths./v1/setup_intents/{intent}/confirm.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/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.verification_method in the specification.

Represents a response of the operation postSetupIntentsIntentConfirm.

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), PostSetupIntentsIntentConfirmResponseError is used.