Confirm a SetupIntent
POST {{baseUrl}}/v1/setup_intents/:intent/confirm
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.
If the selected payment method does not require any additional
steps from the customer, the SetupIntent will transition to the
succeeded
status.
Otherwise, it will transition to the requires_action
status and
suggest additional actions via next_action
. If setup fails,
the SetupIntent will transition to the
requires_payment_method
status.
Request Body
[{"name"=>"client_secret", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "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][currency]", "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][default_for][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][default_for][1]", "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][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[blik][code]", "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][currency]", "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[link][persistent_token]", "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][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"return_url", "value"=>"<string>", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |