Confirm a PaymentIntent

POST {{baseUrl}}/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 will transition to the requires_payment_method status. 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. Read the expanded documentation to learn more about manual confirmation.

Request Body

[{"name"=>"capture_method", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"client_secret", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"error_on_requires_action", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"mandate", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"mandate_data[customer_acceptance][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"mandate_data[customer_acceptance][accepted_at]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"mandate_data[customer_acceptance][online][ip_address]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"mandate_data[customer_acceptance][online][user_agent]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[acss_debit][account_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[acss_debit][institution_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[acss_debit][transit_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[au_becs_debit][account_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[au_becs_debit][bsb_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[bacs_debit][account_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[bacs_debit][sort_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][address][city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][address][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][address][line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][address][line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][address][postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][address][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][email]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[billing_details][phone]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[boleto][tax_id]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[eps][bank]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[fpx][bank]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[ideal][bank]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[klarna][dob][day]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_data[klarna][dob][month]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_data[klarna][dob][year]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_data[metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"payment_method_data[p24][bank]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[radar_options][session]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[sepa_debit][iban]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[sofort][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[us_bank_account][account_holder_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[us_bank_account][account_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[us_bank_account][account_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[us_bank_account][financial_connections_account]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_data[us_bank_account][routing_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][custom_mandate_url]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][interval_description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][payment_schedule]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][transaction_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[affirm][capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[affirm][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[afterpay_clearpay][capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[afterpay_clearpay][reference]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[afterpay_clearpay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[alipay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[au_becs_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[bacs_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[bancontact][preferred_language]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[bancontact][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[blik][code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[boleto][expires_after_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[boleto][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][cvc_token]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][installments][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][installments][plan][count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][installments][plan][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][installments][plan][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][amount_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][reference]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][start_date]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][end_date]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][supported_types][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][mandate_options][supported_types][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][network]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][request_three_d_secure]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][statement_descriptor_suffix_kana]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][statement_descriptor_suffix_kanji]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card_present][request_extended_authorization]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[card_present][request_incremental_authorization_support]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][eu_bank_transfer][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][requested_address_types][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][requested_address_types][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][funding_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[eps][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[fpx][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[giropay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[grabpay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[ideal][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[klarna][capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[klarna][preferred_locale]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[klarna][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][confirmation_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][expires_after_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][expires_at]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][product_description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[link][capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[link][persistent_token]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[link][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[oxxo][expires_after_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[oxxo][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[p24][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[p24][tos_shown_and_accepted]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[paynow][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[pix][expires_after_seconds]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[pix][expires_at]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"payment_method_options[pix][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[promptpay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[sepa_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[sofort][preferred_language]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[sofort][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][financial_connections][permissions][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][financial_connections][permissions][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][financial_connections][return_url]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][networks][requested][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][networks][requested][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[wechat_pay][client]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[wechat_pay][app_id]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[wechat_pay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_types[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_types[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"radar_options[session]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"return_url", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"setup_future_usage", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[address][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[carrier]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[phone]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping[tracking_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"use_stripe_sdk", "value"=>"<boolean>", "datatype"=>"string"}]

HEADERS