Sample - Stripe API
POST/v1/payment_intents/{intent}/confirm

Confirm a PaymentIntent

Confirms that the customer intends to pay with the current or a supplied payment method and initiates a payment attempt. The PaymentIntent may require customer action, return to requires-confirmation for another server-side attempt, succeed, require capture, or become canceled after the confirmation limit is reached.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 24 body fields
intentstringrequired
The identifier of the PaymentIntent to confirm. Maximum 5,000 characters.

Optional form-encoded parameters specifying the payment method, confirmation amount, customer authentication, and related options.

allowed_payment_method_typesarray<string>optional
The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the `payment_method_types` field of the response, based on the other PaymentIntent parameters, such as `currency`, `amount`, and `customer`.
amount_detailsobjectoptional
Provides industry-specific information about the amount.
amount_to_confirmintegeroptional
Amount to confirm on the PaymentIntent. Defaults to `amount` if not provided.
capture_methodstringoptional
Controls when the funds will be captured from the customer's account.
Allowed:automaticautomatic_asyncmanual
client_secretstringoptional
The client secret of the PaymentIntent.
confirmation_tokenstringoptional
ID of the ConfirmationToken used to confirm this PaymentIntent. 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.
error_on_requires_actionbooleanoptional
Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://docs.stripe.com/payments/save-card-without-authentication).
excluded_payment_method_typesarray<string>optional
The list of payment method types to exclude from use with this payment.
expandarray<string>optional
Specifies which fields in the response should be expanded.
hooksobjectoptional
Automations to be run during the PaymentIntent lifecycle
mandatestringoptional
ID of the mandate that's used for this payment.
mandate_dataobjectoptional
Mandate creation details; the object form must include `customer_acceptance`.
off_sessionbooleanoptional
Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect payment method details and [charge them later](https://docs.stripe.com/payments/save-during-payment).
payment_detailsobjectoptional
Provides industry-specific information about the charge.
payment_methodstringoptional
ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the [customer](https://api.stripe.com#create_payment_intent-customer) that is set on this PaymentIntent.
payment_method_dataobjectoptional
If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.
payment_method_optionsobjectoptional
Payment method-specific configuration for this PaymentIntent.
payment_method_typesarray<string>optional
The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
radar_optionsobjectoptional
Options to configure Radar. Learn more about [Radar Sessions](https://docs.stripe.com/radar/radar-session).
receipt_emailstringoptional
Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
return_urlstringoptional
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 is only used for cards and other redirect-based payment methods.
setup_future_usagestringoptional
Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
Allowed:off_sessionon_session
shippingobjectoptional
Shipping information for this PaymentIntent.
use_stripe_sdkbooleanoptional
Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

2 status codes
200Returns the confirmed PaymentIntent object with its resulting status, payment attempt details, next action when required, and current payment amounts.
allowed_payment_method_typesarray<string>optional
The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the `payment_method_types` field of the response, based on the other PaymentIntent parameters, such as `currency`, `amount`, and `customer`.
amountintegeroptional
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
amount_capturableintegeroptional
Amount that can be captured from this PaymentIntent.
amount_detailsobjectoptional
amount_receivedintegeroptional
Amount that this PaymentIntent collects.
applicationstringoptional
ID of the Connect application that created the PaymentIntent.
application_fee_amountintegeroptional
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
automatic_payment_methodsobjectoptional
Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
canceled_atintegeroptional
Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
cancellation_reasonstringoptional
Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).
Allowed:abandonedautomaticduplicateexpiredfailed_invoicefraudulentrequested_by_customervoid_invoice
capture_methodstringoptional
Controls when the funds will be captured from the customer's account.
Allowed:automaticautomatic_asyncmanual
client_secretstringoptional
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.
confirmation_methodstringoptional
Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
Allowed:automaticmanual
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringoptional
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
customerstringoptional
ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
customer_accountstringoptional
ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
excluded_payment_method_typesarray<string>optional
The list of payment method types to exclude from use with this payment.
hooksobjectoptional
idstringrequired
Unique identifier for the object.
last_payment_errorobjectoptional
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
latest_chargestringoptional
ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
managed_paymentsobjectoptional
Settings for Managed Payments.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
next_actionobjectoptional
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:payment_intent
on_behalf_ofstringoptional
You can specify the settlement merchant as the connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details.
payment_detailsobjectoptional
payment_methodstringoptional
ID of the payment method used in this PaymentIntent.
payment_method_configuration_detailsobjectoptional
Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent.
payment_method_optionsobjectoptional
Payment-method-specific configuration for this PaymentIntent.
payment_method_typesarray<string>optional
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
presentment_detailsobjectoptional
processingobjectoptional
If present, this property tells you about the processing state of the payment.
receipt_emailstringoptional
Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
reviewstringoptional
ID of the review associated with this PaymentIntent, if any.
setup_future_usagestringoptional
Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
Allowed:off_sessionon_session
shippingobjectoptional
Shipping information for this PaymentIntent.
statement_descriptorstringoptional
Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
statement_descriptor_suffixstringoptional
Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
statusstringrequired
Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses).
Allowed:canceledprocessingrequires_actionrequires_capturerequires_confirmationrequires_payment_methodsucceeded
transfer_dataobjectoptional
The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
transfer_groupstringoptional
A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers).
defaultReturns an error object containing an `error` field with the error type and related details.
errorobjectrequired

Error handling

intent must identify the PaymentIntent to confirm. If provided, capture_method must be automatic, automatic_async, or manual, off_session must be a boolean or one_off/recurring, and mandate_data must include customer_acceptance; handle next_action when the status becomes requires_action.