Interface: Stripe

index.Stripe

Methods

confirmAcssDebitPayment

▸ confirmAcssDebitPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmAcssDebitPayment in the Accept a Canadian pre-authorized debit payment flow when the customer submits your payment form. When called, it will automatically pop up a modal to collect bank account details and verification, accept the mandate, and confirm the PaymentIntent when the user submits the form.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. stripe.confirmAcssDebitPayment automatically creates a new PaymentMethod for you when your customer completes the modal UI. It can also be called with an existing PaymentMethod which will load the modal UI to collect a new mandate agreement. If you have already attached a PaymentMethod, you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_acss_debit_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmAcssDebitPaymentData
options?	ConfirmAcssDebitPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:86

---

confirmAcssDebitSetup

▸ confirmAcssDebitSetup(clientSecret, data?, options?): Promise<SetupIntentResult>

Use stripe.confirmAcssDebitSetup to save details for future payments with pre-authorized debit in Canada. When called, it will automatically pop up a modal to collect bank account details and verification, accept the mandate, and confirm the SetupIntent when the user submits the form.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. stripe.confirmAcssDebitSetup automatically creates a new PaymentMethod for you when your customer completes the modal UI. It can also be called with an existing PaymentMethod which will load the modal UI to collect a new mandate agreement. If you have already attached a PaymentMethod, you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_acss_debit_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmAcssDebitSetupData
options?	ConfirmAcssDebitSetupOptions

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:540

---

confirmAffirmPayment

▸ confirmAffirmPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmAffirmPayment in the Affirm payments flow when the customer submits your payment form. When called, it will confirm the PaymentIntent. Refer to our integration guide for more details.

docs https://stripe.com/docs/js/payment_intents/confirm_affirm_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmAffirmPaymentData
options?	ConfirmAffirmPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:694

---

confirmAfterpayClearpayPayment

▸ confirmAfterpayClearpayPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmAfterpayClearpayPayment in the Afterpay / Clearpay payments flow when the customer submits your payment form. When called, it will confirm the PaymentIntent. Refer to our integration guide for more details.

docs https://stripe.com/docs/js/payment_intents/confirm_afterpay_clearpay_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmAfterpayClearpayPaymentData
options?	ConfirmAfterpayClearpayPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:708

---

confirmAlipayPayment

▸ confirmAlipayPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmAlipayPayment in the Alipay Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_alipay_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmAlipayPaymentData
options?	ConfirmAlipayPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:103

---

confirmAuBecsDebitPayment

▸ confirmAuBecsDebitPayment(clientSecret, data?): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmAuBecsDebitPayment in the BECS Direct Debit Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_au_becs_debit_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmAuBecsDebitPaymentData

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:124

---

confirmAuBecsDebitSetup

▸ confirmAuBecsDebitSetup(clientSecret, data?): Promise<SetupIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmAuBecsDebitSetup in the BECS Direct Debit with Setup Intents flow when the customer submits your payment form. When called, it will confirm the SetupIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_au_becs_debit_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmAuBecsDebitSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:561

---

confirmBacsDebitSetup

▸ confirmBacsDebitSetup(clientSecret, data?): Promise<SetupIntentResult>

Use stripe.confirmBacsDebitSetup in the Bacs Direct Debit Payments flow when the customer submits your payment form. When called, it will confirm the SetupIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_bacs_debit_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmBacsDebitSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:578

---

confirmBancontactPayment

▸ confirmBancontactPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmBancontactPayment in the Bancontact Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_bancontact_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmBancontactPaymentData
options?	ConfirmBancontactPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:140

---

confirmBancontactSetup

▸ confirmBancontactSetup(clientSecret, data?): Promise<SetupIntentResult>

Use stripe.confirmBancontactSetup in the Set up future payments flow to use Bancontact bank details to set up a SEPA Direct Debit payment method for future payments. When called, it will confirm a SetupIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_bancontact_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmBancontactSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:596

---

confirmBoletoPayment

▸ confirmBoletoPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmBoletoPayment in the Boleto Payment with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_boleto_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmBoletoPaymentData
options?	ConfirmBoletoPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:158

---

confirmCardPayment

▸ confirmCardPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmCardPayment when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide and carry out 3DS or other next actions if they are required.

If you are using Dynamic 3D Secure, stripe.confirmCardPayment will trigger your Radar rules to execute and may open a dialog for your customer to authenticate their payment.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_card_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmCardPaymentData
options?	ConfirmCardPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:176

---

confirmCardSetup

▸ confirmCardSetup(clientSecret, data?, options?): Promise<SetupIntentResult>

Use stripe.confirmCardSetup in the Setup Intents API flow when the customer submits your payment form. When called, it will confirm the SetupIntent with data you provide and carry out 3DS or other next actions if they are required.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_card_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmCardSetupData
options?	ConfirmCardSetupOptions

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:611

---

confirmCustomerBalancePayment

▸ confirmCustomerBalancePayment(clientSecret, data, options): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmCustomerBalancePayment when the customer submits your payment form.

When called, it will confirm the PaymentIntent with data you provide. Refer to our integration guide for more details.

Since the Customer Balance payment method draws from a balance, the attempt will succeed or fail depending on the current balance amount. To collect more funds from the customer when the cash balance is insufficient, use the customer balance with bank transfer funding parameters. The confirmation attempt will finish in one of the following result states:

1. If the customer balance was enough to pay the amount, the status is succeeded. The funding_type data is effectively ignored.
2. If the balance was not enough to pay the amount, and you didn't send the funding_type, the status is requires_payment_method.
3. If the balance was not enough to pay the amount, and you did send the funding_type, the status is requires_action. The paymentIntent.next_action.display_bank_transfer_instructions hash contains bank transfer details for funding the Customer Balance.

docs https://stripe.com/docs/js/payment_intents/confirm_customer_balance_payment

Parameters

Name	Type
clientSecret	string
data	ConfirmCustomerBalancePaymentData
options	ConfirmCustomerBalancePaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:199

---

confirmEpsPayment

▸ confirmEpsPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmEpsPayment in the EPS Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_eps_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmEpsPaymentData
options?	ConfirmEpsPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:216

---

confirmFpxPayment

▸ confirmFpxPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmFpxPayment in the FPX Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_fpx_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmFpxPaymentData
options?	ConfirmFpxPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:233

---

confirmGiropayPayment

▸ confirmGiropayPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmGiropayPayment in the giropay Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_giropay_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmGiropayPaymentData
options?	ConfirmGiropayPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:250

---

confirmGrabPayPayment

▸ confirmGrabPayPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmGrabPayPayment in the GrabPay payments flow when the customer submits your payment form. When called, it will confirm the PaymentIntent. Refer to our integration guide for more details.

docs https://stripe.com/docs/js/payment_intents/confirm_grabpay_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmGrabPayPaymentData
options?	ConfirmGrabPayPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:264

---

confirmIdealPayment

▸ confirmIdealPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmIdealPayment in the iDEAL Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_ideal_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmIdealPaymentData
options?	ConfirmIdealPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:281

---

confirmIdealSetup

▸ confirmIdealSetup(clientSecret, data?): Promise<SetupIntentResult>

Use stripe.confirmIdealSetup in the Set up future payments flow to use iDEAL bank details to set up a SEPA Direct Debit payment method for future payments. When called, it will confirm a SetupIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_ideal_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmIdealSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:630

---

confirmKlarnaPayment

▸ confirmKlarnaPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmKlarnaPayment in the Klarna Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_klarna_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmKlarnaPaymentData
options?	ConfirmKlarnaPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:301

---

confirmOxxoPayment

▸ confirmOxxoPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmOxxoPayment in the OXXO Payment with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_oxxo_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmOxxoPaymentData
options?	ConfirmOxxoPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:319

---

confirmP24Payment

▸ confirmP24Payment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Use stripe.confirmP24Payment in the Przelewy24 Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_p24_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmP24PaymentData
options?	ConfirmP24PaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:336

---

confirmPayNowPayment

▸ confirmPayNowPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmPayNowPayment in the PayNow Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

Parameters

Name	Type
clientSecret	string
data?	ConfirmPayNowPaymentData
options?	ConfirmPayNowPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:354

---

confirmPayPalPayment

▸ confirmPayPalPayment(clientSecret, data?): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmPayPalPayment in the PayPal Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_paypal_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmPayPalPaymentData

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:374

---

confirmPayPalSetup

▸ confirmPayPalSetup(clientSecret, data?): Promise<SetupIntentResult>

Use stripe.confirmPayPalSetup in the Set up future payments flow when the customer submits your payment form. When called, it will confirm a SetupIntent with data you provide, and it will automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_paypal_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmPayPalSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:648

---

confirmPayment

▸ confirmPayment(options): Promise<PaymentIntentResult>

Use stripe.confirmPayment to confirm a PaymentIntent using data collected by the Payment Element. When called, stripe.confirmPayment will attempt to complete any required actions, such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.

By default, stripe.confirmPayment will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmPayment will only redirect if your user chooses a redirect-based payment method. Setting if_required requires that you handle successful confirmations for redirect-based and non-redirect based payment methods separately.

docs https://stripe.com/docs/js/payment_intents/confirm_payment

Parameters

Name	Type
options	Object
options.confirmParams?	Partial<ConfirmPaymentData>
options.elements	StripeElements
options.redirect	"if_required"

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:56

▸ confirmPayment(options): Promise<{ error: StripeError }>

Use stripe.confirmPayment to confirm a PaymentIntent using data collected by the Payment Element. When called, stripe.confirmPayment will attempt to complete any required actions, such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.

docs https://stripe.com/docs/js/payment_intents/confirm_payment

Parameters

Name	Type
options	Object
options.confirmParams	ConfirmPaymentData
options.elements	StripeElements
options.redirect?	"always"

Returns

Promise<{ error: StripeError }>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:69

---

confirmPromptPayPayment

▸ confirmPromptPayPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmPromptPayPayment in the PromptPay Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

Parameters

Name	Type
clientSecret	string
data?	ConfirmPromptPayPaymentData
options?	ConfirmPromptPayPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:391

---

confirmSepaDebitPayment

▸ confirmSepaDebitPayment(clientSecret, data?): Promise<PaymentIntentResult>

Use stripe.confirmSepaDebitPayment in the SEPA Direct Debit Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_sepa_debit_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmSepaDebitPaymentData

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:409

---

confirmSepaDebitSetup

▸ confirmSepaDebitSetup(clientSecret, data?): Promise<SetupIntentResult>

Use stripe.confirmSepaDebitSetup in the SEPA Direct Debit with Setup Intents flow when the customer submits your payment form. When called, it will confirm the SetupIntent with data you provide. Note that there are some additional requirements to this flow that are not covered in this reference. Refer to our integration guide for more details.

When you confirm a SetupIntent, it needs to have an attached PaymentMethod. In addition to confirming the SetupIntent, this method can automatically create and attach a new PaymentMethod for you. It can also be called with an existing PaymentMethod, or if you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/setup_intents/confirm_sepa_debit_setup

Parameters

Name	Type
clientSecret	string
data?	ConfirmSepaDebitSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:665

---

confirmSetup

▸ confirmSetup(options): Promise<SetupIntentResult>

Use stripe.confirmSetup to confirm a SetupIntent using data collected by the Payment Element. When called, stripe.confirmSetup will attempt to complete any required actions, such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.

By default, stripe.confirmSetup will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmSetup will only redirect if your user chooses a redirect-based payment method. Setting if_required requires that you handle successful confirmations for redirect-based and non-redirect based payment methods separately.

docs https://stripe.com/docs/js/setup_intents/confirm_setup

Parameters

Name	Type
options	Object
options.confirmParams?	Partial<ConfirmPaymentData>
options.elements	StripeElements
options.redirect	"if_required"

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:510

▸ confirmSetup(options): Promise<{ error: StripeError }>

Use stripe.confirmSetup to confirm a SetupIntent using data collected by the Payment Element. When called, stripe.confirmSetup will attempt to complete any required actions, such as authenticating your user by displaying a 3DS dialog or redirecting them to a bank authorization page. Your user will be redirected to the return_url you pass once the confirmation is complete.

docs https://stripe.com/docs/js/setup_intents/confirm_setup

Parameters

Name	Type
options	Object
options.confirmParams	ConfirmPaymentData
options.elements	StripeElements
options.redirect?	"always"

Returns

Promise<{ error: StripeError }>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:523

---

confirmSofortPayment

▸ confirmSofortPayment(clientSecret, data?): Promise<PaymentIntentResult>

Use stripe.confirmSofortPayment in the Sofort Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. It will then automatically redirect the customer to authorize the transaction. Once authorization is complete, the customer will be redirected back to your specified return_url.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_sofort_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmSofortPaymentData

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:425

---

confirmSofortSetup

▸ confirmSofortSetup(clientSecret, data?): Promise<SetupIntentResult>

Parameters

Name	Type
clientSecret	string
data?	ConfirmSofortSetupData

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:681

---

confirmWechatPayPayment

▸ confirmWechatPayPayment(clientSecret, data?, options?): Promise<PaymentIntentResult>

Requires beta access: Contact Stripe support for more information.

Use stripe.confirmWechatPayPayment in the Wechat Pay Payments with Payment Methods flow when the customer submits your payment form. When called, it will confirm the PaymentIntent with data you provide. Refer to our integration guide for more details.

When you confirm a PaymentIntent, it needs to have an attached PaymentMethod. In addition to confirming the PaymentIntent, this method can automatically create and attach a new PaymentMethod for you. If you have already attached a PaymentMethod you can call this method without needing to provide any additional data.

docs https://stripe.com/docs/js/payment_intents/confirm_wechat_pay_payment

Parameters

Name	Type
clientSecret	string
data?	ConfirmWechatPayPaymentData
options?	ConfirmWechatPayPaymentOptions

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:444

---

createPaymentMethod

▸ createPaymentMethod(paymentMethodData): Promise<PaymentMethodResult>

Use stripe.createPaymentMethod to convert payment information collected by elements into a PaymentMethod object that you safely pass to your server to use in an API call.

docs https://stripe.com/docs/js/payment_methods/create_payment_method

Parameters

Name	Type
paymentMethodData	CreatePaymentMethodData

Returns

Promise<PaymentMethodResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:482

---

createSource

▸ createSource(element, sourceData): Promise<SourceResult>

Use stripe.createSource to convert payment information collected by elements into a Source object that you safely pass to your server to use in an API call. See the Sources documentation for more information about sources.

Parameters

Name	Type
element	StripeElement
sourceData	CreateSourceData

Returns

Promise<SourceResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:829

▸ createSource(sourceData): Promise<SourceResult>

Use stripe.createSource to convert raw payment information into a Source object that you safely pass to your server to use in an API call. See the Sources documentation for more information about sources.

Parameters

Name	Type
sourceData	CreateSourceData

Returns

Promise<SourceResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:838

---

createToken

▸ createToken(tokenType, data): Promise<TokenResult>

Use stripe.createToken to convert information collected by an IbanElement into a single-use Token that you safely pass to your server to use in an API call.

docs https://stripe.com/docs/js/tokens_sources/create_token?type=ibanElement

Parameters

Name	Type
tokenType	StripeIbanElement
data	CreateTokenIbanData

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:757

▸ createToken(tokenType, data?): Promise<TokenResult>

Use stripe.createToken to convert information collected by card elements into a single-use Token that you safely pass to your server to use in an API call.

docs https://stripe.com/docs/js/tokens_sources/create_token?type=cardElement

Parameters

Name	Type
tokenType	StripeCardElement | StripeCardNumberElement
data?	CreateTokenCardData

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:767

▸ createToken(tokenType, data): Promise<TokenResult>

Use stripe.createToken to convert personally identifiable information (PII) into a single-use Token for account identity verification.

docs https://stripe.com/docs/js/tokens_sources/create_token?type=pii

Parameters

Name	Type
tokenType	"pii"
data	CreateTokenPiiData

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:777

▸ createToken(tokenType, data): Promise<TokenResult>

Use stripe.createToken to convert bank account information into a single-use token that you safely pass to your server to use in an API call.

docs https://stripe.com/docs/js/tokens_sources/create_token?type=bank_account

Parameters

Name	Type
tokenType	"bank_account"
data	CreateTokenBankAccountData

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:787

▸ createToken(tokenType, element): Promise<TokenResult>

Use stripe.createToken to tokenize the recollected CVC for a saved card.

First, render a CardCvcElement to collect the data. Then pass the CardCvcElement to stripe.createToken to tokenize the collected data.

docs https://stripe.com/docs/js/tokens_sources/create_token?type=cvc_update

Parameters

Name	Type
tokenType	"cvc_update"
element	StripeCardCvcElement

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:800

▸ createToken(tokenType, data): Promise<TokenResult>

Use stripe.createToken to create a single-use token that wraps a user’s legal entity information. Use this when creating or updating a Connect account. See the account tokens documentation to learn more.

Parameters

Name	Type
tokenType	"account"
data	Account

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:810

▸ createToken(tokenType, data): Promise<TokenResult>

Use stripe.createToken to create a single-use token that represents the details for a person. Use this when creating or updating persons associated with a Connect account. See the documentation to learn more.

Parameters

Name	Type
tokenType	"person"
data	Person

Returns

Promise<TokenResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:820

---

elements

▸ elements(options?): StripeElements

Create an Elements instance, which manages a group of elements.

Parameters

Name	Type
options?	StripeElementsOptions

Returns

StripeElements

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:23

---

handleCardAction

▸ handleCardAction(clientSecret): Promise<PaymentIntentResult>

Use stripe.handleCardAction in the Payment Intents API manual confirmation flow to handle a PaymentIntent with the requires_action status. It will throw an error if the PaymentIntent has a different status.

Note that stripe.handleCardAction may take several seconds to complete. During that time, you should disable your form from being resubmitted and show a waiting indicator like a spinner. If you receive an error result, you should be sure to show that error to the customer, re-enable the form, and hide the waiting indicator.

Additionally, stripe.handleCardAction may trigger a 3D Secure authentication challenge. The authentication challenge requires a context switch that can be hard to follow on a screen-reader. Ensure that your form is accessible by ensuring that success or error messages are clearly read out.

docs https://stripe.com/docs/js/payment_intents/handle_card_action

Parameters

Name	Type
clientSecret	string

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:464

---

paymentRequest

▸ paymentRequest(options): PaymentRequest

Use stripe.paymentRequest to create a PaymentRequest object. Creating a PaymentRequest requires that you configure it with an options object.

In Safari, stripe.paymentRequest uses Apple Pay, and in other browsers it uses the Payment Request API standard.

Parameters

Name	Type
options	PaymentRequestOptions

Returns

PaymentRequest

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:744

---

redirectToCheckout

▸ redirectToCheckout(options): Promise<{ error: StripeError }>

Use stripe.redirectToCheckout to redirect your customers to Checkout, a Stripe-hosted page to securely collect payment information. When the customer completes their purchase, they are redirected back to your website.

Parameters

Name	Type
options	RedirectToCheckoutOptions

Returns

Promise<{ error: StripeError }>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:35

---

registerAppInfo

▸ registerAppInfo(wrapperLibrary): void

Use stripe.registerAppInfo to register a frontend open source library.

Parameters

Name	Type
wrapperLibrary	WrapperLibrary

Returns

void

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:855

---

retrievePaymentIntent

▸ retrievePaymentIntent(clientSecret): Promise<PaymentIntentResult>

Retrieve a PaymentIntent using its client secret.

docs https://stripe.com/docs/js/payment_intents/retrieve_payment_intent

Parameters

Name	Type
clientSecret	string

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:491

---

retrieveSetupIntent

▸ retrieveSetupIntent(clientSecret): Promise<SetupIntentResult>

Retrieve a SetupIntent using its client secret.

docs https://stripe.com/docs/js/setup_intents/retrieve_setup_intent

Parameters

Name	Type
clientSecret	string

Returns

Promise<SetupIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:730

---

retrieveSource

▸ retrieveSource(source): Promise<SourceResult>

Retrieve a Source using its unique ID and client secret.

docs https://stripe.com/docs/js/tokens_sources/retrieve_source

Parameters

Name	Type
source	RetrieveSourceParam

Returns

Promise<SourceResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:845

---

verifyIdentity

▸ verifyIdentity(clientSecret): Promise<VerificationSessionResult>

Use stripe.verifyIdentity to display an Identity modal that securely collects verification information.

• @docs https://stripe.com/docs/js/identity/modal

Parameters

Name	Type
clientSecret	string

Returns

Promise<VerificationSessionResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:867

---

verifyMicrodepositsForPayment

▸ verifyMicrodepositsForPayment(clientSecret, data?): Promise<PaymentIntentResult>

Use stripe.verifyMicrodepositsForPayment in the Accept a Canadian pre-authorized debit payment flow to verify a customer's bank account with micro-deposits.

docs https://stripe.com/docs/js/payment_intents/verify_microdeposits_for_payment

Parameters

Name	Type
clientSecret	string
data?	VerifyMicrodepositsForPaymentData

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:472

---

verifyMicrodepositsForSetup

▸ verifyMicrodepositsForSetup(clientSecret, data?): Promise<PaymentIntentResult>

Use stripe.verifyMicrodepositsForSetup in the Save details for future payments with pre-authorized debit in Canada flow to verify customer's bank account with micro-deposits.

docs https://stripe.com/docs/js/payment_intents/verify_microdeposits_for_setup

Parameters

Name	Type
clientSecret	string
data?	VerifyMicrodepositsForSetupData

Returns

Promise<PaymentIntentResult>

Defined in

mint-sdk-js/node_modules/@stripe/stripe-js/types/stripe-js/stripe.d.ts:720