StripeAPI.Operations.PostPaymentIntentsIntentConfirm

POST /v1/payment_intents/{intent}/confirm

<p>Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.</p>

<p>If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If payment fails, the PaymentIntent will transition to the <code>requires_payment_method</code> status. If payment succeeds, the PaymentIntent will transition to the <code>succeeded</code> status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>).</p>

<p>If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted using our <a href="/docs/stripe-js/reference#stripe-handle-card-payment">client SDKs</a> and the PaymentIntent’s <a href="#payment_intent_object-client_secret">client_secret</a>. After <code>next_action</code>s are handled by the client, no additional confirmation is required to complete the payment.</p>

<p>If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the <code>requires_confirmation</code> state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the <a href="/docs/payments/payment-intents/web-manual">expanded documentation</a> to learn more about manual confirmation.</p>

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

Create a new PostPaymentIntentsIntentConfirmRequestBody with all required fields.

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

Controls when the funds will be captured from the customer's account.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyMandateData' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online' with all required fields.

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

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

Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later.

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

If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'AcssDebit' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'AuBecsDebit' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'BacsDebit' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'BillingDetails' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'BillingDetails'Address'OneOf1 with all required fields.

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

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

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

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

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

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

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

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

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

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

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'Klarna'Dob' with all required fields.

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

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

Defines the enum schema located at paths./v1/payment_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/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'RadarOptions' with all required fields.

Defines the object schema located at paths./v1/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'SepaDebit' with all required fields.

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

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

Defines the enum schema located at paths./v1/payment_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/payment_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/payment_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 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodData'UsBankAccount' with all required fields.

Defines the enum schema located at paths./v1/payment_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/payment_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/payment_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 PaymentIntent.

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions' with all required fields.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'AcssDebit'OneOf1 with all required fields.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'AcssDebit'OneOf1MandateOptions' with all required fields.

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

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.anyOf.properties.mandate_options.properties.payment_schedule in the specification.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.anyOf.properties.mandate_options.properties.transaction_type in the specification.

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

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

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

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Affirm'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.affirm.anyOf.properties.capture_method in the specification.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.affirm.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.affirm.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'AfterpayClearpay'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.afterpay_clearpay.anyOf.properties.capture_method in the specification.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.afterpay_clearpay.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.afterpay_clearpay.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Alipay'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.alipay.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.alipay.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'AuBecsDebit'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.au_becs_debit.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.au_becs_debit.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'BacsDebit'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bacs_debit.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bacs_debit.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Bancontact'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bancontact.anyOf.properties.preferred_language in the specification.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bancontact.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bancontact.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Boleto'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.boleto.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.boleto.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.capture_method in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'OneOf1Installments' with all required fields.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'OneOf1Installments'Plan'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.installments.properties.plan.anyOf in the specification.

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

Create a new PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'OneOf1MandateOptions' with all required fields.

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

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

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

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.network in the specification.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.request_three_d_secure in the specification.

Defines the enum schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.setup_future_usage in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.statement_descriptor_suffix_kana.anyOf in the specification.

Defines the oneOf schema located at paths./v1/payment_intents/{intent}/confirm.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.anyOf.properties.statement_descriptor_suffix_kanji.anyOf in the specification.