POST /v1/payment_intents/{intent}/confirm

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.

Servers

Path parameters

Name Type Required Description
intent String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
client_secret String No

The client secret of the PaymentIntent.

confirmation_token String No

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.

expand[] Array No

Specifies which fields in the response should be expanded.

use_stripe_sdk Boolean No

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

receipt_email No

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.

mandate_data No
off_session No

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 card details and charge them later.

payment_method String No

ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the customer that is set on this PaymentIntent.

payment_method_options Object No

Payment method-specific configuration for this PaymentIntent.

payment_method_options.swish No
payment_method_options.multibanco No
payment_method_options.affirm No
payment_method_options.mobilepay No
payment_method_options.paynow No
payment_method_options.customer_balance No
payment_method_options.pix No
payment_method_options.sofort No
payment_method_options.alipay No
payment_method_options.interac_present No
payment_method_options.cashapp No
payment_method_options.zip No
payment_method_options.afterpay_clearpay No
payment_method_options.twint No
payment_method_options.eps No
payment_method_options.us_bank_account No
payment_method_options.au_becs_debit No
payment_method_options.konbini No
payment_method_options.oxxo No
payment_method_options.bancontact No
payment_method_options.p24 No
payment_method_options.card No
payment_method_options.ideal No
payment_method_options.amazon_pay No
payment_method_options.paypal No
payment_method_options.bacs_debit No
payment_method_options.naver_pay No
payment_method_options.klarna No
payment_method_options.acss_debit No
payment_method_options.blik No
payment_method_options.payco No
payment_method_options.wechat_pay No
payment_method_options.pay_by_bank No
payment_method_options.promptpay No
payment_method_options.giropay No
payment_method_options.kakao_pay No
payment_method_options.crypto No
payment_method_options.alma No
payment_method_options.link No
payment_method_options.satispay No
payment_method_options.card_present No
payment_method_options.fpx No
payment_method_options.revolut_pay No
payment_method_options.billie No
payment_method_options.sepa_debit No
payment_method_options.kr_card No
payment_method_options.samsung_pay No
payment_method_options.nz_bank_account No
payment_method_options.grabpay No
payment_method_options.boleto No
return_url String No

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.

error_on_requires_action Boolean No

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.

setup_future_usage String No

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

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.

Possible values:

  • ""
  • "off_session"
  • "on_session"
payment_method_data Object No

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

payment_method_data.swish Object No
payment_method_data.metadata Object No
payment_method_data.multibanco Object No
payment_method_data.affirm Object No
payment_method_data.mobilepay Object No
payment_method_data.paynow Object No
payment_method_data.billing_details Object No
payment_method_data.billing_details.email No
payment_method_data.billing_details.name No
payment_method_data.billing_details.tax_id String No
payment_method_data.billing_details.phone No
payment_method_data.billing_details.address No
payment_method_data.customer_balance Object No
payment_method_data.pix Object No
payment_method_data.sofort Object No
payment_method_data.sofort.country String Yes

Possible values:

  • "ES"
  • "NL"
  • "IT"
  • "AT"
  • "BE"
  • "DE"
payment_method_data.alipay Object No
payment_method_data.interac_present Object No
payment_method_data.cashapp Object No
payment_method_data.zip Object No
payment_method_data.type String Yes

Possible values:

  • "p24"
  • "pay_by_bank"
  • "blik"
  • "crypto"
  • "amazon_pay"
  • "boleto"
  • "bacs_debit"
  • "giropay"
  • "eps"
  • "paynow"
  • "pix"
  • "fpx"
  • "promptpay"
  • "zip"
  • "alipay"
  • "naver_pay"
  • "revolut_pay"
  • "billie"
  • "klarna"
  • "bancontact"
  • "kr_card"
  • "swish"
  • "paypal"
  • "samsung_pay"
  • "sofort"
  • "nz_bank_account"
  • "au_becs_debit"
  • "kakao_pay"
  • "konbini"
  • "acss_debit"
  • "link"
  • "alma"
  • "satispay"
  • "payco"
  • "sepa_debit"
  • "us_bank_account"
  • "oxxo"
  • "cashapp"
  • "affirm"
  • "twint"
  • "afterpay_clearpay"
  • "customer_balance"
  • "grabpay"
  • "multibanco"
  • "ideal"
  • "wechat_pay"
  • "mobilepay"
payment_method_data.afterpay_clearpay Object No
payment_method_data.twint Object No
payment_method_data.eps Object No
payment_method_data.eps.bank String No

Possible values:

  • "vr_bank_braunau"
  • "hypo_bank_burgenland_aktiengesellschaft"
  • "bank_austria"
  • "austrian_anadi_bank_ag"
  • "volkskreditbank_ag"
  • "bankhaus_carl_spangler"
  • "bawag_psk_ag"
  • "bankhaus_schelhammer_und_schattera_ag"
  • "capital_bank_grawe_gruppe_ag"
  • "raiffeisen_bankengruppe_osterreich"
  • "btv_vier_lander_bank"
  • "dolomitenbank"
  • "erste_bank_und_sparkassen"
  • "hypo_alpeadriabank_international_ag"
  • "schoellerbank_ag"
  • "marchfelder_bank"
  • "volksbank_gruppe"
  • "hypo_vorarlberg_bank_ag"
  • "bks_bank_ag"
  • "hypo_oberosterreich_salzburg_steiermark"
  • "easybank_ag"
  • "deutsche_bank_ag"
  • "sparda_bank_wien"
  • "hypo_tirol_bank_ag"
  • "arzte_und_apotheker_bank"
  • "brull_kallmus_bank_ag"
  • "oberbank_ag"
  • "hypo_noe_lb_fur_niederosterreich_u_wien"
payment_method_data.us_bank_account Object No
payment_method_data.us_bank_account.routing_number String No
payment_method_data.us_bank_account.account_number String No
payment_method_data.us_bank_account.financial_connections_account String No
payment_method_data.us_bank_account.account_holder_type String No

Possible values:

  • "company"
  • "individual"
payment_method_data.us_bank_account.account_type String No

Possible values:

  • "checking"
  • "savings"
payment_method_data.au_becs_debit Object No
payment_method_data.au_becs_debit.account_number String Yes
payment_method_data.au_becs_debit.bsb_number String Yes
payment_method_data.konbini Object No
payment_method_data.oxxo Object No
payment_method_data.bancontact Object No
payment_method_data.p24 Object No
payment_method_data.p24.bank String No

Possible values:

  • "banki_spbdzielcze"
  • "credit_agricole"
  • "bank_millennium"
  • "inteligo"
  • "plus_bank"
  • "bank_nowy_bfg_sa"
  • "citi_handlowy"
  • "blik"
  • "getin_bank"
  • "velobank"
  • "bank_pekao_sa"
  • "boz"
  • "ideabank"
  • "volkswagen_bank"
  • "alior_bank"
  • "bnp_paribas"
  • "tmobile_usbugi_bankowe"
  • "toyota_bank"
  • "mbank_mtransfer"
  • "santander_przelew24"
  • "etransfer_pocztowy24"
  • "envelobank"
  • "nest_przelew"
  • "ing"
  • "noble_pay"
  • "pbac_z_ipko"
payment_method_data.allow_redisplay String No

Possible values:

  • "limited"
  • "unspecified"
  • "always"
payment_method_data.radar_options Object No
payment_method_data.radar_options.session String No
payment_method_data.ideal Object No
payment_method_data.ideal.bank String No

Possible values:

  • "knab"
  • "n26"
  • "rabobank"
  • "sns_bank"
  • "triodos_bank"
  • "bunq"
  • "buut"
  • "van_lanschot"
  • "nn"
  • "ing"
  • "abn_amro"
  • "asn_bank"
  • "handelsbanken"
  • "revolut"
  • "moneyou"
  • "regiobank"
  • "yoursafe"
payment_method_data.amazon_pay Object No
payment_method_data.paypal Object No
payment_method_data.bacs_debit Object No
payment_method_data.bacs_debit.sort_code String No
payment_method_data.bacs_debit.account_number String No
payment_method_data.naver_pay Object No
payment_method_data.naver_pay.funding String No

Possible values:

  • "card"
  • "points"
payment_method_data.klarna Object No
payment_method_data.klarna.dob Object No
payment_method_data.klarna.dob.day Integer Yes
payment_method_data.klarna.dob.month Integer Yes
payment_method_data.klarna.dob.year Integer Yes
payment_method_data.acss_debit Object No
payment_method_data.acss_debit.institution_number String Yes
payment_method_data.acss_debit.transit_number String Yes
payment_method_data.acss_debit.account_number String Yes
payment_method_data.blik Object No
payment_method_data.payco Object No
payment_method_data.wechat_pay Object No
payment_method_data.pay_by_bank Object No
payment_method_data.promptpay Object No
payment_method_data.giropay Object No
payment_method_data.kakao_pay Object No
payment_method_data.crypto Object No
payment_method_data.alma Object No
payment_method_data.link Object No
payment_method_data.satispay Object No
payment_method_data.fpx Object No
payment_method_data.fpx.bank String Yes

Possible values:

  • "bank_rakyat"
  • "hsbc"
  • "hong_leong_bank"
  • "ocbc"
  • "kfh"
  • "public_bank"
  • "alliance_bank"
  • "maybank2u"
  • "uob"
  • "agrobank"
  • "bsn"
  • "deutsche_bank"
  • "cimb"
  • "rhb"
  • "ambank"
  • "standard_chartered"
  • "affin_bank"
  • "bank_islam"
  • "pb_enterprise"
  • "maybank2e"
  • "bank_of_china"
  • "bank_muamalat"
payment_method_data.revolut_pay Object No
payment_method_data.billie Object No
payment_method_data.sepa_debit Object No
payment_method_data.sepa_debit.iban String Yes
payment_method_data.kr_card Object No
payment_method_data.samsung_pay Object No
payment_method_data.nz_bank_account Object No
payment_method_data.nz_bank_account.bank_code String Yes
payment_method_data.nz_bank_account.branch_code String Yes
payment_method_data.nz_bank_account.account_number String Yes
payment_method_data.nz_bank_account.account_holder_name String No
payment_method_data.nz_bank_account.reference String No
payment_method_data.nz_bank_account.suffix String Yes
payment_method_data.grabpay Object No
payment_method_data.boleto Object No
payment_method_data.boleto.tax_id String Yes
capture_method String No

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

Possible values:

  • "manual"
  • "automatic"
  • "automatic_async"
mandate String No

ID of the mandate that's used for this payment.

shipping No

Shipping information for this PaymentIntent.

payment_method_types[] Array No

The list of payment method types (for example, a card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.

radar_options Object No

Options to configure Radar. Learn more about Radar Sessions.

radar_options.session String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.