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
- https://api.stripe.com/
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 |
|---|---|---|---|
excluded_payment_method_types |
No |
The list of payment method types to exclude from use with this payment. |
|
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 |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
hooks |
Object | No |
Automations to be run during the PaymentIntent lifecycle |
hooks.inputs |
Object | No | |
hooks.inputs.tax |
Object | No | |
hooks.inputs.tax.calculation |
Yes | ||
use_stripe_sdk |
Boolean | No |
Set to |
amount_details |
No |
Provides industry-specific information about the amount. |
|
receipt_email |
No |
Email address that the receipt for the resulting payment will be sent to. If |
|
mandate_data |
No | ||
off_session |
No |
Set to |
|
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.upi |
No | ||
payment_method_options.bancontact |
No | ||
payment_method_options.p24 |
No | ||
payment_method_options.mb_way |
No | ||
payment_method_options.card |
No | ||
payment_method_options.ideal |
No | ||
payment_method_options.payto |
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 |
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 When processing card payments, Stripe uses If you've already set Valid values:
|
payment_details |
No |
Provides industry-specific information about the charge. |
|
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 |
Valid values:
|
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 |
Valid values:
|
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 |
Valid values:
|
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 |
Valid values:
|
payment_method_data.us_bank_account.account_type |
String | No |
Valid values:
|
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.upi |
Object | No | |
payment_method_data.upi.mandate_options |
Object | No | |
payment_method_data.upi.mandate_options.description |
String | No | |
payment_method_data.upi.mandate_options.amount_type |
String | No |
Valid values:
|
payment_method_data.upi.mandate_options.end_date |
Integer | No | |
payment_method_data.upi.mandate_options.amount |
Integer | No | |
payment_method_data.bancontact |
Object | No | |
payment_method_data.p24 |
Object | No | |
payment_method_data.p24.bank |
String | No |
Valid values:
|
payment_method_data.mb_way |
Object | No | |
payment_method_data.allow_redisplay |
String | No |
Valid values:
|
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 |
Valid values:
|
payment_method_data.payto |
Object | No | |
payment_method_data.payto.pay_id |
String | No | |
payment_method_data.payto.account_number |
String | No | |
payment_method_data.payto.bsb_number |
String | No | |
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 |
Valid values:
|
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 |
Valid values:
|
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. Valid values:
|
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 |
radar_options |
Object | No |
Options to configure Radar. Learn more about Radar Sessions. |
radar_options.session |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.