Module payment_intent Copy item path Source ApplyCustomerBalancePaymentIntent Manually reconcile the remaining amount for a customer_balance PaymentIntent. CancelPaymentIntent You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases , processing. CapturePaymentIntent Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture. CapturePaymentIntentTransferData The parameters that you can use to automatically create a transfer after the payment
is captured.
Learn more about the use case for connected accounts . ConfirmPaymentIntent 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. ConfirmPaymentIntentClientKeyParam ConfirmPaymentIntentClientKeyParamCustomerAcceptance This hash contains details about the customer acceptance of the Mandate. ConfirmPaymentIntentClientKeyParamCustomerAcceptanceOnline If this is a Mandate accepted online, this hash contains details about the online acceptance. ConfirmPaymentIntentPaymentMethodData If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
in the payment_method .
property on the PaymentIntent. ConfirmPaymentIntentPaymentMethodDataAuBecsDebit If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account. ConfirmPaymentIntentPaymentMethodDataBacsDebit If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. ConfirmPaymentIntentPaymentMethodDataBillingDetails Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. ConfirmPaymentIntentPaymentMethodDataBillingDetailsAddress Billing address. ConfirmPaymentIntentPaymentMethodDataBoleto If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method. ConfirmPaymentIntentPaymentMethodDataEps If this is an eps PaymentMethod, this hash contains details about the EPS payment method. ConfirmPaymentIntentPaymentMethodDataFpx If this is an fpx PaymentMethod, this hash contains details about the FPX payment method. ConfirmPaymentIntentPaymentMethodDataIdeal If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method. ConfirmPaymentIntentPaymentMethodDataKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method. ConfirmPaymentIntentPaymentMethodDataNaverPay If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method. ConfirmPaymentIntentPaymentMethodDataNzBankAccount If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. ConfirmPaymentIntentPaymentMethodDataP24 If this is a p24 PaymentMethod, this hash contains details about the P24 payment method. ConfirmPaymentIntentPaymentMethodDataSepaDebit If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account. ConfirmPaymentIntentPaymentMethodDataSofort If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method. ConfirmPaymentIntentPaymentMethodDataUsBankAccount If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method. ConfirmPaymentIntentPaymentMethodOptions Payment method-specific configuration for this PaymentIntent. ConfirmPaymentIntentPaymentMethodOptionsAcssDebit If this is a acss_debit PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options. ConfirmPaymentIntentPaymentMethodOptionsAcssDebitMandateOptions Additional fields for Mandate creation ConfirmPaymentIntentPaymentMethodOptionsAffirm If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options. ConfirmPaymentIntentPaymentMethodOptionsAfterpayClearpay If this is a afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options. ConfirmPaymentIntentPaymentMethodOptionsAlipay If this is a alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options. ConfirmPaymentIntentPaymentMethodOptionsAlma If this is a alma PaymentMethod, this sub-hash contains details about the Alma payment method options. ConfirmPaymentIntentPaymentMethodOptionsAmazonPay If this is a amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsAuBecsDebit If this is a au_becs_debit PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options. ConfirmPaymentIntentPaymentMethodOptionsBacsDebit If this is a bacs_debit PaymentMethod, this sub-hash contains details about the BACS Debit payment method options. ConfirmPaymentIntentPaymentMethodOptionsBancontact If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options. ConfirmPaymentIntentPaymentMethodOptionsBillie If this is a billie PaymentMethod, this sub-hash contains details about the Billie payment method options. ConfirmPaymentIntentPaymentMethodOptionsBlik If this is a blik PaymentMethod, this sub-hash contains details about the BLIK payment method options. ConfirmPaymentIntentPaymentMethodOptionsBoleto If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options. ConfirmPaymentIntentPaymentMethodOptionsCard Configuration for any card payments attempted on this PaymentIntent. ConfirmPaymentIntentPaymentMethodOptionsCardInstallments Installment configuration for payments attempted on this PaymentIntent (Mexico Only). ConfirmPaymentIntentPaymentMethodOptionsCardInstallmentsPlan The selected installment plan to use for this payment attempt.
This parameter can only be provided during confirmation. ConfirmPaymentIntentPaymentMethodOptionsCardMandateOptions Configuration options for setting up an eMandate for cards issued in India. ConfirmPaymentIntentPaymentMethodOptionsCardPresent If this is a card_present PaymentMethod, this sub-hash contains details about the Card Present payment method options. ConfirmPaymentIntentPaymentMethodOptionsCardPresentRouting Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes. ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecure If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this payment. ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires Cartes Bancaires-specific 3DS fields. ConfirmPaymentIntentPaymentMethodOptionsCashapp If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsCustomerBalance If this is a customer balance PaymentMethod, this sub-hash contains details about the customer balance payment method options. ConfirmPaymentIntentPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer. ConfirmPaymentIntentPaymentMethodOptionsEps If this is a eps PaymentMethod, this sub-hash contains details about the EPS payment method options. ConfirmPaymentIntentPaymentMethodOptionsFpx If this is a fpx PaymentMethod, this sub-hash contains details about the FPX payment method options. ConfirmPaymentIntentPaymentMethodOptionsGiropay If this is a giropay PaymentMethod, this sub-hash contains details about the Giropay payment method options. ConfirmPaymentIntentPaymentMethodOptionsGrabpay If this is a grabpay PaymentMethod, this sub-hash contains details about the Grabpay payment method options. ConfirmPaymentIntentPaymentMethodOptionsIdeal If this is a ideal PaymentMethod, this sub-hash contains details about the Ideal payment method options. ConfirmPaymentIntentPaymentMethodOptionsKakaoPay If this is a kakao_pay PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsKlarna If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options. ConfirmPaymentIntentPaymentMethodOptionsKonbini If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options. ConfirmPaymentIntentPaymentMethodOptionsKrCard If this is a kr_card PaymentMethod, this sub-hash contains details about the KR Card payment method options. ConfirmPaymentIntentPaymentMethodOptionsLink If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options. ConfirmPaymentIntentPaymentMethodOptionsMobilepay If this is a MobilePay PaymentMethod, this sub-hash contains details about the MobilePay payment method options. ConfirmPaymentIntentPaymentMethodOptionsMultibanco If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options. ConfirmPaymentIntentPaymentMethodOptionsNaverPay If this is a naver_pay PaymentMethod, this sub-hash contains details about the Naver Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsNzBankAccount If this is a nz_bank_account PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options. ConfirmPaymentIntentPaymentMethodOptionsOxxo If this is a oxxo PaymentMethod, this sub-hash contains details about the OXXO payment method options. ConfirmPaymentIntentPaymentMethodOptionsP24 If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options. ConfirmPaymentIntentPaymentMethodOptionsPayco If this is a payco PaymentMethod, this sub-hash contains details about the PAYCO payment method options. ConfirmPaymentIntentPaymentMethodOptionsPaynow If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow payment method options. ConfirmPaymentIntentPaymentMethodOptionsPaypal If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options. ConfirmPaymentIntentPaymentMethodOptionsPix If this is a pix PaymentMethod, this sub-hash contains details about the Pix payment method options. ConfirmPaymentIntentPaymentMethodOptionsPromptpay If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options. ConfirmPaymentIntentPaymentMethodOptionsRevolutPay If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsSamsungPay If this is a samsung_pay PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsSepaDebit If this is a sepa_debit PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. ConfirmPaymentIntentPaymentMethodOptionsSepaDebitMandateOptions Additional fields for Mandate creation ConfirmPaymentIntentPaymentMethodOptionsSofort If this is a sofort PaymentMethod, this sub-hash contains details about the SOFORT payment method options. ConfirmPaymentIntentPaymentMethodOptionsSwish If this is a Swish PaymentMethod, this sub-hash contains details about the Swish payment method options. ConfirmPaymentIntentPaymentMethodOptionsTwint If this is a twint PaymentMethod, this sub-hash contains details about the TWINT payment method options. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccount If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnections Additional fields for Financial Connections Session creation ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Provide filters for the linked accounts that the customer can select for the payment method. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountMandateOptions Additional fields for Mandate creation ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountNetworks Additional fields for network related functions ConfirmPaymentIntentPaymentMethodOptionsWechatPay If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options. ConfirmPaymentIntentPaymentMethodOptionsZip If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options. ConfirmPaymentIntentSecretKeyParam ConfirmPaymentIntentSecretKeyParamCustomerAcceptance This hash contains details about the customer acceptance of the Mandate. ConfirmPaymentIntentShipping Shipping information for this PaymentIntent. ConfirmPaymentIntentShippingAddress Shipping address. CreatePaymentIntent Creates a PaymentIntent object. CreatePaymentIntentAutomaticPaymentMethods When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent’s other parameters. CreatePaymentIntentMandateData This hash contains details about the Mandate to create.
This parameter can only be used with confirm=true CreatePaymentIntentMandateDataCustomerAcceptance This hash contains details about the customer acceptance of the Mandate. CreatePaymentIntentPaymentMethodData If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
in the payment_method .
property on the PaymentIntent. CreatePaymentIntentPaymentMethodDataAuBecsDebit If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account. CreatePaymentIntentPaymentMethodDataBacsDebit If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. CreatePaymentIntentPaymentMethodDataBillingDetails Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. CreatePaymentIntentPaymentMethodDataBillingDetailsAddress Billing address. CreatePaymentIntentPaymentMethodDataBoleto If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method. CreatePaymentIntentPaymentMethodDataEps If this is an eps PaymentMethod, this hash contains details about the EPS payment method. CreatePaymentIntentPaymentMethodDataFpx If this is an fpx PaymentMethod, this hash contains details about the FPX payment method. CreatePaymentIntentPaymentMethodDataIdeal If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method. CreatePaymentIntentPaymentMethodDataKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method. CreatePaymentIntentPaymentMethodDataNaverPay If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method. CreatePaymentIntentPaymentMethodDataNzBankAccount If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. CreatePaymentIntentPaymentMethodDataP24 If this is a p24 PaymentMethod, this hash contains details about the P24 payment method. CreatePaymentIntentPaymentMethodDataSepaDebit If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account. CreatePaymentIntentPaymentMethodDataSofort If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method. CreatePaymentIntentPaymentMethodDataUsBankAccount If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method. CreatePaymentIntentPaymentMethodOptions Payment method-specific configuration for this PaymentIntent. CreatePaymentIntentPaymentMethodOptionsAcssDebit If this is a acss_debit PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options. CreatePaymentIntentPaymentMethodOptionsAcssDebitMandateOptions Additional fields for Mandate creation CreatePaymentIntentPaymentMethodOptionsAffirm If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options. CreatePaymentIntentPaymentMethodOptionsAfterpayClearpay If this is a afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options. CreatePaymentIntentPaymentMethodOptionsAlipay If this is a alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options. CreatePaymentIntentPaymentMethodOptionsAlma If this is a alma PaymentMethod, this sub-hash contains details about the Alma payment method options. CreatePaymentIntentPaymentMethodOptionsAmazonPay If this is a amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options. CreatePaymentIntentPaymentMethodOptionsAuBecsDebit If this is a au_becs_debit PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options. CreatePaymentIntentPaymentMethodOptionsBacsDebit If this is a bacs_debit PaymentMethod, this sub-hash contains details about the BACS Debit payment method options. CreatePaymentIntentPaymentMethodOptionsBancontact If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options. CreatePaymentIntentPaymentMethodOptionsBillie If this is a billie PaymentMethod, this sub-hash contains details about the Billie payment method options. CreatePaymentIntentPaymentMethodOptionsBlik If this is a blik PaymentMethod, this sub-hash contains details about the BLIK payment method options. CreatePaymentIntentPaymentMethodOptionsBoleto If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options. CreatePaymentIntentPaymentMethodOptionsCard Configuration for any card payments attempted on this PaymentIntent. CreatePaymentIntentPaymentMethodOptionsCardInstallments Installment configuration for payments attempted on this PaymentIntent (Mexico Only). CreatePaymentIntentPaymentMethodOptionsCardInstallmentsPlan The selected installment plan to use for this payment attempt.
This parameter can only be provided during confirmation. CreatePaymentIntentPaymentMethodOptionsCardMandateOptions Configuration options for setting up an eMandate for cards issued in India. CreatePaymentIntentPaymentMethodOptionsCardPresent If this is a card_present PaymentMethod, this sub-hash contains details about the Card Present payment method options. CreatePaymentIntentPaymentMethodOptionsCardPresentRouting Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes. CreatePaymentIntentPaymentMethodOptionsCardThreeDSecure If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this payment. CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires Cartes Bancaires-specific 3DS fields. CreatePaymentIntentPaymentMethodOptionsCashapp If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options. CreatePaymentIntentPaymentMethodOptionsCustomerBalance If this is a customer balance PaymentMethod, this sub-hash contains details about the customer balance payment method options. CreatePaymentIntentPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer. CreatePaymentIntentPaymentMethodOptionsEps If this is a eps PaymentMethod, this sub-hash contains details about the EPS payment method options. CreatePaymentIntentPaymentMethodOptionsFpx If this is a fpx PaymentMethod, this sub-hash contains details about the FPX payment method options. CreatePaymentIntentPaymentMethodOptionsGiropay If this is a giropay PaymentMethod, this sub-hash contains details about the Giropay payment method options. CreatePaymentIntentPaymentMethodOptionsGrabpay If this is a grabpay PaymentMethod, this sub-hash contains details about the Grabpay payment method options. CreatePaymentIntentPaymentMethodOptionsIdeal If this is a ideal PaymentMethod, this sub-hash contains details about the Ideal payment method options. CreatePaymentIntentPaymentMethodOptionsKakaoPay If this is a kakao_pay PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options. CreatePaymentIntentPaymentMethodOptionsKlarna If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options. CreatePaymentIntentPaymentMethodOptionsKonbini If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options. CreatePaymentIntentPaymentMethodOptionsKrCard If this is a kr_card PaymentMethod, this sub-hash contains details about the KR Card payment method options. CreatePaymentIntentPaymentMethodOptionsLink If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options. CreatePaymentIntentPaymentMethodOptionsMobilepay If this is a MobilePay PaymentMethod, this sub-hash contains details about the MobilePay payment method options. CreatePaymentIntentPaymentMethodOptionsMultibanco If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options. CreatePaymentIntentPaymentMethodOptionsNaverPay If this is a naver_pay PaymentMethod, this sub-hash contains details about the Naver Pay payment method options. CreatePaymentIntentPaymentMethodOptionsNzBankAccount If this is a nz_bank_account PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options. CreatePaymentIntentPaymentMethodOptionsOxxo If this is a oxxo PaymentMethod, this sub-hash contains details about the OXXO payment method options. CreatePaymentIntentPaymentMethodOptionsP24 If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options. CreatePaymentIntentPaymentMethodOptionsPayco If this is a payco PaymentMethod, this sub-hash contains details about the PAYCO payment method options. CreatePaymentIntentPaymentMethodOptionsPaynow If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow payment method options. CreatePaymentIntentPaymentMethodOptionsPaypal If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options. CreatePaymentIntentPaymentMethodOptionsPix If this is a pix PaymentMethod, this sub-hash contains details about the Pix payment method options. CreatePaymentIntentPaymentMethodOptionsPromptpay If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options. CreatePaymentIntentPaymentMethodOptionsRevolutPay If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options. CreatePaymentIntentPaymentMethodOptionsSamsungPay If this is a samsung_pay PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. CreatePaymentIntentPaymentMethodOptionsSepaDebit If this is a sepa_debit PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. CreatePaymentIntentPaymentMethodOptionsSepaDebitMandateOptions Additional fields for Mandate creation CreatePaymentIntentPaymentMethodOptionsSofort If this is a sofort PaymentMethod, this sub-hash contains details about the SOFORT payment method options. CreatePaymentIntentPaymentMethodOptionsSwish If this is a Swish PaymentMethod, this sub-hash contains details about the Swish payment method options. CreatePaymentIntentPaymentMethodOptionsTwint If this is a twint PaymentMethod, this sub-hash contains details about the TWINT payment method options. CreatePaymentIntentPaymentMethodOptionsUsBankAccount If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options. CreatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnections Additional fields for Financial Connections Session creation CreatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Provide filters for the linked accounts that the customer can select for the payment method. CreatePaymentIntentPaymentMethodOptionsUsBankAccountMandateOptions Additional fields for Mandate creation CreatePaymentIntentPaymentMethodOptionsUsBankAccountNetworks Additional fields for network related functions CreatePaymentIntentPaymentMethodOptionsWechatPay If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options. CreatePaymentIntentPaymentMethodOptionsZip If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options. CreatePaymentIntentShipping Shipping information for this PaymentIntent. CreatePaymentIntentShippingAddress Shipping address. CreatePaymentIntentTransferData The parameters that you can use to automatically create a Transfer.
Learn more about the use case for connected accounts . DateOfBirth EuBankTransferParams IncrementAuthorizationPaymentIntent Perform an incremental authorization on an eligible
PaymentIntent . To be eligible, the
PaymentIntent’s status must be requires_capture and
incremental_authorization_supported .
must be true. IncrementAuthorizationPaymentIntentTransferData The parameters used to automatically create a transfer after the payment is captured.
Learn more about the use case for connected accounts . ListPaymentIntent Returns a list of PaymentIntents. OnlineParam PaymentMethodOptionsMandateOptionsParam PaymentMethodParam RadarOptionsWithHiddenOptions RetrievePaymentIntent Retrieves the details of a PaymentIntent that has previously been created. SearchPaymentIntent Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language .
Don’t use search in read-after-write flows where strict consistency is necessary.
Under normal operating.
conditions, data is searchable in less than a minute.
Occasionally, propagation of new or updated data can be up.
to an hour behind during outages. Search functionality is not available to merchants in India. UpdatePaymentIntent Updates properties on a PaymentIntent object without confirming. UpdatePaymentIntentPaymentMethodData If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
in the payment_method .
property on the PaymentIntent. UpdatePaymentIntentPaymentMethodDataAuBecsDebit If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account. UpdatePaymentIntentPaymentMethodDataBacsDebit If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. UpdatePaymentIntentPaymentMethodDataBillingDetails Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. UpdatePaymentIntentPaymentMethodDataBillingDetailsAddress Billing address. UpdatePaymentIntentPaymentMethodDataBoleto If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method. UpdatePaymentIntentPaymentMethodDataEps If this is an eps PaymentMethod, this hash contains details about the EPS payment method. UpdatePaymentIntentPaymentMethodDataFpx If this is an fpx PaymentMethod, this hash contains details about the FPX payment method. UpdatePaymentIntentPaymentMethodDataIdeal If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method. UpdatePaymentIntentPaymentMethodDataKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method. UpdatePaymentIntentPaymentMethodDataNaverPay If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method. UpdatePaymentIntentPaymentMethodDataNzBankAccount If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. UpdatePaymentIntentPaymentMethodDataP24 If this is a p24 PaymentMethod, this hash contains details about the P24 payment method. UpdatePaymentIntentPaymentMethodDataSepaDebit If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account. UpdatePaymentIntentPaymentMethodDataSofort If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method. UpdatePaymentIntentPaymentMethodDataUsBankAccount If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method. UpdatePaymentIntentPaymentMethodOptions Payment-method-specific configuration for this PaymentIntent. UpdatePaymentIntentPaymentMethodOptionsAcssDebit If this is a acss_debit PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options. UpdatePaymentIntentPaymentMethodOptionsAcssDebitMandateOptions Additional fields for Mandate creation UpdatePaymentIntentPaymentMethodOptionsAffirm If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options. UpdatePaymentIntentPaymentMethodOptionsAfterpayClearpay If this is a afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options. UpdatePaymentIntentPaymentMethodOptionsAlipay If this is a alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options. UpdatePaymentIntentPaymentMethodOptionsAlma If this is a alma PaymentMethod, this sub-hash contains details about the Alma payment method options. UpdatePaymentIntentPaymentMethodOptionsAmazonPay If this is a amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsAuBecsDebit If this is a au_becs_debit PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options. UpdatePaymentIntentPaymentMethodOptionsBacsDebit If this is a bacs_debit PaymentMethod, this sub-hash contains details about the BACS Debit payment method options. UpdatePaymentIntentPaymentMethodOptionsBancontact If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options. UpdatePaymentIntentPaymentMethodOptionsBillie If this is a billie PaymentMethod, this sub-hash contains details about the Billie payment method options. UpdatePaymentIntentPaymentMethodOptionsBlik If this is a blik PaymentMethod, this sub-hash contains details about the BLIK payment method options. UpdatePaymentIntentPaymentMethodOptionsBoleto If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options. UpdatePaymentIntentPaymentMethodOptionsCard Configuration for any card payments attempted on this PaymentIntent. UpdatePaymentIntentPaymentMethodOptionsCardInstallments Installment configuration for payments attempted on this PaymentIntent (Mexico Only). UpdatePaymentIntentPaymentMethodOptionsCardInstallmentsPlan The selected installment plan to use for this payment attempt.
This parameter can only be provided during confirmation. UpdatePaymentIntentPaymentMethodOptionsCardMandateOptions Configuration options for setting up an eMandate for cards issued in India. UpdatePaymentIntentPaymentMethodOptionsCardPresent If this is a card_present PaymentMethod, this sub-hash contains details about the Card Present payment method options. UpdatePaymentIntentPaymentMethodOptionsCardPresentRouting Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes. UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecure If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this payment. UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires Cartes Bancaires-specific 3DS fields. UpdatePaymentIntentPaymentMethodOptionsCashapp If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsCustomerBalance If this is a customer balance PaymentMethod, this sub-hash contains details about the customer balance payment method options. UpdatePaymentIntentPaymentMethodOptionsCustomerBalanceBankTransfer Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer. UpdatePaymentIntentPaymentMethodOptionsEps If this is a eps PaymentMethod, this sub-hash contains details about the EPS payment method options. UpdatePaymentIntentPaymentMethodOptionsFpx If this is a fpx PaymentMethod, this sub-hash contains details about the FPX payment method options. UpdatePaymentIntentPaymentMethodOptionsGiropay If this is a giropay PaymentMethod, this sub-hash contains details about the Giropay payment method options. UpdatePaymentIntentPaymentMethodOptionsGrabpay If this is a grabpay PaymentMethod, this sub-hash contains details about the Grabpay payment method options. UpdatePaymentIntentPaymentMethodOptionsIdeal If this is a ideal PaymentMethod, this sub-hash contains details about the Ideal payment method options. UpdatePaymentIntentPaymentMethodOptionsKakaoPay If this is a kakao_pay PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsKlarna If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options. UpdatePaymentIntentPaymentMethodOptionsKonbini If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options. UpdatePaymentIntentPaymentMethodOptionsKrCard If this is a kr_card PaymentMethod, this sub-hash contains details about the KR Card payment method options. UpdatePaymentIntentPaymentMethodOptionsLink If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options. UpdatePaymentIntentPaymentMethodOptionsMobilepay If this is a MobilePay PaymentMethod, this sub-hash contains details about the MobilePay payment method options. UpdatePaymentIntentPaymentMethodOptionsMultibanco If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options. UpdatePaymentIntentPaymentMethodOptionsNaverPay If this is a naver_pay PaymentMethod, this sub-hash contains details about the Naver Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsNzBankAccount If this is a nz_bank_account PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options. UpdatePaymentIntentPaymentMethodOptionsOxxo If this is a oxxo PaymentMethod, this sub-hash contains details about the OXXO payment method options. UpdatePaymentIntentPaymentMethodOptionsP24 If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options. UpdatePaymentIntentPaymentMethodOptionsPayco If this is a payco PaymentMethod, this sub-hash contains details about the PAYCO payment method options. UpdatePaymentIntentPaymentMethodOptionsPaynow If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow payment method options. UpdatePaymentIntentPaymentMethodOptionsPaypal If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options. UpdatePaymentIntentPaymentMethodOptionsPix If this is a pix PaymentMethod, this sub-hash contains details about the Pix payment method options. UpdatePaymentIntentPaymentMethodOptionsPromptpay If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options. UpdatePaymentIntentPaymentMethodOptionsRevolutPay If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsSamsungPay If this is a samsung_pay PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsSepaDebit If this is a sepa_debit PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. UpdatePaymentIntentPaymentMethodOptionsSepaDebitMandateOptions Additional fields for Mandate creation UpdatePaymentIntentPaymentMethodOptionsSofort If this is a sofort PaymentMethod, this sub-hash contains details about the SOFORT payment method options. UpdatePaymentIntentPaymentMethodOptionsSwish If this is a Swish PaymentMethod, this sub-hash contains details about the Swish payment method options. UpdatePaymentIntentPaymentMethodOptionsTwint If this is a twint PaymentMethod, this sub-hash contains details about the TWINT payment method options. UpdatePaymentIntentPaymentMethodOptionsUsBankAccount If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnections Additional fields for Financial Connections Session creation UpdatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Provide filters for the linked accounts that the customer can select for the payment method. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountMandateOptions Additional fields for Mandate creation UpdatePaymentIntentPaymentMethodOptionsUsBankAccountNetworks Additional fields for network related functions UpdatePaymentIntentPaymentMethodOptionsWechatPay If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options. UpdatePaymentIntentPaymentMethodOptionsZip If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options. UpdatePaymentIntentShipping Shipping information for this PaymentIntent. UpdatePaymentIntentShippingAddress Shipping address. UpdatePaymentIntentTransferData Use this parameter to automatically create a Transfer when the payment succeeds.
Learn more about the use case for connected accounts . VerifyMicrodepositsPaymentIntent Verifies microdeposits on a PaymentIntent object. CancelPaymentIntentCancellationReason Reason for canceling this PaymentIntent.
Possible values are: duplicate, fraudulent, requested_by_customer, or abandoned. ConfirmPaymentIntentClientKeyParamCustomerAcceptanceType The type of customer acceptance information included with the Mandate. ConfirmPaymentIntentMandateData ConfirmPaymentIntentOffSession 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 . ConfirmPaymentIntentPaymentMethodDataAllowRedisplay This field indicates whether this payment method can be shown again to its customer in a checkout flow.
Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
The field defaults to unspecified. ConfirmPaymentIntentPaymentMethodDataEpsBank The customer’s bank. ConfirmPaymentIntentPaymentMethodDataFpxAccountHolderType Account holder type for FPX transaction ConfirmPaymentIntentPaymentMethodDataFpxBank The customer’s bank. ConfirmPaymentIntentPaymentMethodDataIdealBank The customer’s bank.
Only use this parameter for existing customers.
Don’t use it for new customers. ConfirmPaymentIntentPaymentMethodDataNaverPayFunding Whether to use Naver Pay points or a card to fund this transaction.
If not provided, this defaults to card. ConfirmPaymentIntentPaymentMethodDataP24Bank The customer’s bank. ConfirmPaymentIntentPaymentMethodDataSofortCountry Two-letter ISO code representing the country the bank account is located in. ConfirmPaymentIntentPaymentMethodDataType The type of the PaymentMethod.
An additional hash is included on the PaymentMethod with a name matching this value.
It contains additional information specific to the PaymentMethod type. ConfirmPaymentIntentPaymentMethodDataUsBankAccountAccountHolderType Account holder type: individual or company. ConfirmPaymentIntentPaymentMethodDataUsBankAccountAccountType Account type: checkings or savings. Defaults to checking if omitted. ConfirmPaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsPaymentSchedule Payment schedule for the mandate. ConfirmPaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsTransactionType Transaction type of the mandate. ConfirmPaymentIntentPaymentMethodOptionsAcssDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsAcssDebitVerificationMethod Bank account verification method. ConfirmPaymentIntentPaymentMethodOptionsAffirmCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsAffirmSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsAfterpayClearpayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsAfterpayClearpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsAlipaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsAlmaCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsAmazonPayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsAmazonPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsAuBecsDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsBacsDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsBancontactPreferredLanguage Preferred language of the Bancontact authorization page that the customer is redirected to. ConfirmPaymentIntentPaymentMethodOptionsBancontactSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsBillieCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsBlikSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsBoletoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsCardCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsCardInstallmentsPlanInterval For fixed_count installment plans, this is required.
It represents the interval between installment payments your customer will make to their credit card.
One of month. ConfirmPaymentIntentPaymentMethodOptionsCardInstallmentsPlanType Type of installment plan, one of fixed_count. ConfirmPaymentIntentPaymentMethodOptionsCardMandateOptionsAmountType One of fixed or maximum.
If fixed, the amount param refers to the exact amount to be charged in future payments.
If maximum, the amount charged can be up to the value passed for the amount param. ConfirmPaymentIntentPaymentMethodOptionsCardMandateOptionsInterval Specifies payment frequency. One of day, week, month, year, or sporadic. ConfirmPaymentIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes Specifies the type of mandates supported. Possible values are india. ConfirmPaymentIntentPaymentMethodOptionsCardNetwork Selected network to process this PaymentIntent on.
Depends on the available networks of the card attached to the PaymentIntent.
Can be only set confirm-time. ConfirmPaymentIntentPaymentMethodOptionsCardPresentRoutingRequestedPriority Routing requested priority ConfirmPaymentIntentPaymentMethodOptionsCardRequestExtendedAuthorization Request ability to capture beyond the standard authorization validity window for this PaymentIntent. ConfirmPaymentIntentPaymentMethodOptionsCardRequestIncrementalAuthorization Request ability to increment the authorization for this PaymentIntent. ConfirmPaymentIntentPaymentMethodOptionsCardRequestMulticapture Request ability to make multiple captures for this PaymentIntent. ConfirmPaymentIntentPaymentMethodOptionsCardRequestOvercapture Request ability to overcapture for this PaymentIntent. ConfirmPaymentIntentPaymentMethodOptionsCardRequestThreeDSecure We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements .
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to automatic.
Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. ConfirmPaymentIntentPaymentMethodOptionsCardSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureAresTransStatus The transStatus returned from the card Issuer’s ACS in the ARes. ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureElectronicCommerceIndicator The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed. ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureExemptionIndicator The exemption requested via 3DS and accepted by the issuer at authentication time. ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesCbAvalgo The cryptogram calculation algorithm used by the card Issuer’s ACS
to calculate the Authentication cryptogram. Also known as cavvAlgorithm.
messageExtension: CB-AVALGO ConfirmPaymentIntentPaymentMethodOptionsCardThreeDSecureVersion The version of 3D Secure that was performed. ConfirmPaymentIntentPaymentMethodOptionsCashappCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsCashappSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferRequestedAddressTypes List of address types that should be returned in the financial_addresses response.
If not specified, all valid types will be returned. ConfirmPaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferType The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. ConfirmPaymentIntentPaymentMethodOptionsCustomerBalanceFundingType The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include: bank_transfer. ConfirmPaymentIntentPaymentMethodOptionsCustomerBalanceSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsEpsSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsFpxSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsGiropaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsGrabpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsIdealSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsKakaoPayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsKakaoPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsKlarnaCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsKlarnaPreferredLocale Preferred language of the Klarna authorization page that the customer is redirected to ConfirmPaymentIntentPaymentMethodOptionsKlarnaSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsKonbiniSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsKrCardCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsKrCardSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsLinkCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsLinkSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsMobilepayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsMobilepaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsMultibancoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsNaverPayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsNaverPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsNzBankAccountSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsOxxoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsP24SetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsPaycoCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsPaynowSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsPaypalCaptureMethod Controls when the funds will be captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsPaypalPreferredLocale Preferred locale of the PayPal checkout page that the customer is redirected to.ConfirmPaymentIntentPaymentMethodOptionsPaypalSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsPixSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsPromptpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsRevolutPayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsRevolutPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsSamsungPayCaptureMethod Controls when the funds are captured from the customer’s account. ConfirmPaymentIntentPaymentMethodOptionsSepaDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsSofortPreferredLanguage Language shown to the payer on redirect. ConfirmPaymentIntentPaymentMethodOptionsSofortSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsSwishSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsTwintSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersAccountSubcategories The account subcategories to use to filter for selectable accounts.
Valid subcategories are checking and savings. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions The list of permissions to request.
If this parameter is passed, the payment_method permission must be included.
Valid permissions include: balances, ownership, payment_method, and transactions. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch List of data features that you would like to retrieve upon account creation. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod The method used to collect offline mandate customer acceptance. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountNetworksRequested Triggers validations to run across the selected networks ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountPreferredSettlementSpeed Preferred transaction settlement speed ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsUsBankAccountVerificationMethod Bank account verification method. ConfirmPaymentIntentPaymentMethodOptionsWechatPayClient The client type that the end customer will pay from ConfirmPaymentIntentPaymentMethodOptionsWechatPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentPaymentMethodOptionsZipSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. ConfirmPaymentIntentSecretKeyParamCustomerAcceptanceType The type of customer acceptance information included with the Mandate.
One of online or offline. CreatePaymentIntentAutomaticPaymentMethodsAllowRedirects Controls whether this PaymentIntent will accept redirect-based payment methods. CreatePaymentIntentMandateDataCustomerAcceptanceType The type of customer acceptance information included with the Mandate.
One of online or offline. CreatePaymentIntentOffSession 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 .
This parameter can only be used with confirm=true CreatePaymentIntentPaymentMethodDataAllowRedisplay This field indicates whether this payment method can be shown again to its customer in a checkout flow.
Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
The field defaults to unspecified. CreatePaymentIntentPaymentMethodDataEpsBank The customer’s bank. CreatePaymentIntentPaymentMethodDataFpxAccountHolderType Account holder type for FPX transaction CreatePaymentIntentPaymentMethodDataFpxBank The customer’s bank. CreatePaymentIntentPaymentMethodDataIdealBank The customer’s bank.
Only use this parameter for existing customers.
Don’t use it for new customers. CreatePaymentIntentPaymentMethodDataNaverPayFunding Whether to use Naver Pay points or a card to fund this transaction.
If not provided, this defaults to card. CreatePaymentIntentPaymentMethodDataP24Bank The customer’s bank. CreatePaymentIntentPaymentMethodDataSofortCountry Two-letter ISO code representing the country the bank account is located in. CreatePaymentIntentPaymentMethodDataType The type of the PaymentMethod.
An additional hash is included on the PaymentMethod with a name matching this value.
It contains additional information specific to the PaymentMethod type. CreatePaymentIntentPaymentMethodDataUsBankAccountAccountHolderType Account holder type: individual or company. CreatePaymentIntentPaymentMethodDataUsBankAccountAccountType Account type: checkings or savings. Defaults to checking if omitted. CreatePaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsPaymentSchedule Payment schedule for the mandate. CreatePaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsTransactionType Transaction type of the mandate. CreatePaymentIntentPaymentMethodOptionsAcssDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsAcssDebitVerificationMethod Bank account verification method. CreatePaymentIntentPaymentMethodOptionsAffirmCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsAffirmSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsAfterpayClearpayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsAfterpayClearpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsAlipaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsAlmaCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsAmazonPayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsAmazonPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsAuBecsDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsBacsDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsBancontactPreferredLanguage Preferred language of the Bancontact authorization page that the customer is redirected to. CreatePaymentIntentPaymentMethodOptionsBancontactSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsBillieCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsBlikSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsBoletoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsCardCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsCardInstallmentsPlanInterval For fixed_count installment plans, this is required.
It represents the interval between installment payments your customer will make to their credit card.
One of month. CreatePaymentIntentPaymentMethodOptionsCardInstallmentsPlanType Type of installment plan, one of fixed_count. CreatePaymentIntentPaymentMethodOptionsCardMandateOptionsAmountType One of fixed or maximum.
If fixed, the amount param refers to the exact amount to be charged in future payments.
If maximum, the amount charged can be up to the value passed for the amount param. CreatePaymentIntentPaymentMethodOptionsCardMandateOptionsInterval Specifies payment frequency. One of day, week, month, year, or sporadic. CreatePaymentIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes Specifies the type of mandates supported. Possible values are india. CreatePaymentIntentPaymentMethodOptionsCardNetwork Selected network to process this PaymentIntent on.
Depends on the available networks of the card attached to the PaymentIntent.
Can be only set confirm-time. CreatePaymentIntentPaymentMethodOptionsCardPresentRoutingRequestedPriority Routing requested priority CreatePaymentIntentPaymentMethodOptionsCardRequestExtendedAuthorization Request ability to capture beyond the standard authorization validity window for this PaymentIntent. CreatePaymentIntentPaymentMethodOptionsCardRequestIncrementalAuthorization Request ability to increment the authorization for this PaymentIntent. CreatePaymentIntentPaymentMethodOptionsCardRequestMulticapture Request ability to make multiple captures for this PaymentIntent. CreatePaymentIntentPaymentMethodOptionsCardRequestOvercapture Request ability to overcapture for this PaymentIntent. CreatePaymentIntentPaymentMethodOptionsCardRequestThreeDSecure We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements .
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to automatic.
Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. CreatePaymentIntentPaymentMethodOptionsCardSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureAresTransStatus The transStatus returned from the card Issuer’s ACS in the ARes. CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureElectronicCommerceIndicator The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed. CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureExemptionIndicator The exemption requested via 3DS and accepted by the issuer at authentication time. CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesCbAvalgo The cryptogram calculation algorithm used by the card Issuer’s ACS
to calculate the Authentication cryptogram. Also known as cavvAlgorithm.
messageExtension: CB-AVALGO CreatePaymentIntentPaymentMethodOptionsCardThreeDSecureVersion The version of 3D Secure that was performed. CreatePaymentIntentPaymentMethodOptionsCashappCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsCashappSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferRequestedAddressTypes List of address types that should be returned in the financial_addresses response.
If not specified, all valid types will be returned. CreatePaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferType The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. CreatePaymentIntentPaymentMethodOptionsCustomerBalanceFundingType The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include: bank_transfer. CreatePaymentIntentPaymentMethodOptionsCustomerBalanceSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsEpsSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsFpxSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsGiropaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsGrabpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsIdealSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsKakaoPayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsKakaoPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsKlarnaCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsKlarnaPreferredLocale Preferred language of the Klarna authorization page that the customer is redirected to CreatePaymentIntentPaymentMethodOptionsKlarnaSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsKonbiniSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsKrCardCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsKrCardSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsLinkCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsLinkSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsMobilepayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsMobilepaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsMultibancoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsNaverPayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsNaverPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsNzBankAccountSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsOxxoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsP24SetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsPaycoCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsPaynowSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsPaypalCaptureMethod Controls when the funds will be captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsPaypalPreferredLocale Preferred locale of the PayPal checkout page that the customer is redirected to.CreatePaymentIntentPaymentMethodOptionsPaypalSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsPixSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsPromptpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsRevolutPayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsRevolutPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsSamsungPayCaptureMethod Controls when the funds are captured from the customer’s account. CreatePaymentIntentPaymentMethodOptionsSepaDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsSofortPreferredLanguage Language shown to the payer on redirect. CreatePaymentIntentPaymentMethodOptionsSofortSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsSwishSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsTwintSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersAccountSubcategories The account subcategories to use to filter for selectable accounts.
Valid subcategories are checking and savings. CreatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions The list of permissions to request.
If this parameter is passed, the payment_method permission must be included.
Valid permissions include: balances, ownership, payment_method, and transactions. CreatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch List of data features that you would like to retrieve upon account creation. CreatePaymentIntentPaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod The method used to collect offline mandate customer acceptance. CreatePaymentIntentPaymentMethodOptionsUsBankAccountNetworksRequested Triggers validations to run across the selected networks CreatePaymentIntentPaymentMethodOptionsUsBankAccountPreferredSettlementSpeed Preferred transaction settlement speed CreatePaymentIntentPaymentMethodOptionsUsBankAccountSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsUsBankAccountVerificationMethod Bank account verification method. CreatePaymentIntentPaymentMethodOptionsWechatPayClient The client type that the end customer will pay from CreatePaymentIntentPaymentMethodOptionsWechatPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. CreatePaymentIntentPaymentMethodOptionsZipSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodDataAllowRedisplay This field indicates whether this payment method can be shown again to its customer in a checkout flow.
Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
The field defaults to unspecified. UpdatePaymentIntentPaymentMethodDataEpsBank The customer’s bank. UpdatePaymentIntentPaymentMethodDataFpxAccountHolderType Account holder type for FPX transaction UpdatePaymentIntentPaymentMethodDataFpxBank The customer’s bank. UpdatePaymentIntentPaymentMethodDataIdealBank The customer’s bank.
Only use this parameter for existing customers.
Don’t use it for new customers. UpdatePaymentIntentPaymentMethodDataNaverPayFunding Whether to use Naver Pay points or a card to fund this transaction.
If not provided, this defaults to card. UpdatePaymentIntentPaymentMethodDataP24Bank The customer’s bank. UpdatePaymentIntentPaymentMethodDataSofortCountry Two-letter ISO code representing the country the bank account is located in. UpdatePaymentIntentPaymentMethodDataType The type of the PaymentMethod.
An additional hash is included on the PaymentMethod with a name matching this value.
It contains additional information specific to the PaymentMethod type. UpdatePaymentIntentPaymentMethodDataUsBankAccountAccountHolderType Account holder type: individual or company. UpdatePaymentIntentPaymentMethodDataUsBankAccountAccountType Account type: checkings or savings. Defaults to checking if omitted. UpdatePaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsPaymentSchedule Payment schedule for the mandate. UpdatePaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsTransactionType Transaction type of the mandate. UpdatePaymentIntentPaymentMethodOptionsAcssDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsAcssDebitVerificationMethod Bank account verification method. UpdatePaymentIntentPaymentMethodOptionsAffirmCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsAffirmSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsAfterpayClearpayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsAfterpayClearpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsAlipaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsAlmaCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsAmazonPayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsAmazonPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsAuBecsDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsBacsDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsBancontactPreferredLanguage Preferred language of the Bancontact authorization page that the customer is redirected to. UpdatePaymentIntentPaymentMethodOptionsBancontactSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsBillieCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsBlikSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsBoletoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsCardCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsCardInstallmentsPlanInterval For fixed_count installment plans, this is required.
It represents the interval between installment payments your customer will make to their credit card.
One of month. UpdatePaymentIntentPaymentMethodOptionsCardInstallmentsPlanType Type of installment plan, one of fixed_count. UpdatePaymentIntentPaymentMethodOptionsCardMandateOptionsAmountType One of fixed or maximum.
If fixed, the amount param refers to the exact amount to be charged in future payments.
If maximum, the amount charged can be up to the value passed for the amount param. UpdatePaymentIntentPaymentMethodOptionsCardMandateOptionsInterval Specifies payment frequency. One of day, week, month, year, or sporadic. UpdatePaymentIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes Specifies the type of mandates supported. Possible values are india. UpdatePaymentIntentPaymentMethodOptionsCardNetwork Selected network to process this PaymentIntent on.
Depends on the available networks of the card attached to the PaymentIntent.
Can be only set confirm-time. UpdatePaymentIntentPaymentMethodOptionsCardPresentRoutingRequestedPriority Routing requested priority UpdatePaymentIntentPaymentMethodOptionsCardRequestExtendedAuthorization Request ability to capture beyond the standard authorization validity window for this PaymentIntent. UpdatePaymentIntentPaymentMethodOptionsCardRequestIncrementalAuthorization Request ability to increment the authorization for this PaymentIntent. UpdatePaymentIntentPaymentMethodOptionsCardRequestMulticapture Request ability to make multiple captures for this PaymentIntent. UpdatePaymentIntentPaymentMethodOptionsCardRequestOvercapture Request ability to overcapture for this PaymentIntent. UpdatePaymentIntentPaymentMethodOptionsCardRequestThreeDSecure We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements .
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
If not provided, this value defaults to automatic.
Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. UpdatePaymentIntentPaymentMethodOptionsCardSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureAresTransStatus The transStatus returned from the card Issuer’s ACS in the ARes. UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureElectronicCommerceIndicator The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed. UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureExemptionIndicator The exemption requested via 3DS and accepted by the issuer at authentication time. UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesCbAvalgo The cryptogram calculation algorithm used by the card Issuer’s ACS
to calculate the Authentication cryptogram. Also known as cavvAlgorithm.
messageExtension: CB-AVALGO UpdatePaymentIntentPaymentMethodOptionsCardThreeDSecureVersion The version of 3D Secure that was performed. UpdatePaymentIntentPaymentMethodOptionsCashappCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsCashappSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferRequestedAddressTypes List of address types that should be returned in the financial_addresses response.
If not specified, all valid types will be returned. UpdatePaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferType The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. UpdatePaymentIntentPaymentMethodOptionsCustomerBalanceFundingType The funding method type to be used when there are not enough funds in the customer balance.
Permitted values include: bank_transfer. UpdatePaymentIntentPaymentMethodOptionsCustomerBalanceSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsEpsSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsFpxSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsGiropaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsGrabpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsIdealSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsKakaoPayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsKakaoPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsKlarnaCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsKlarnaPreferredLocale Preferred language of the Klarna authorization page that the customer is redirected to UpdatePaymentIntentPaymentMethodOptionsKlarnaSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsKonbiniSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsKrCardCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsKrCardSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsLinkCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsLinkSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsMobilepayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsMobilepaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsMultibancoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsNaverPayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsNaverPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsNzBankAccountSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsOxxoSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsP24SetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsPaycoCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsPaynowSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsPaypalCaptureMethod Controls when the funds will be captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsPaypalPreferredLocale Preferred locale of the PayPal checkout page that the customer is redirected to.UpdatePaymentIntentPaymentMethodOptionsPaypalSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsPixSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsPromptpaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsRevolutPayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsRevolutPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsSamsungPayCaptureMethod Controls when the funds are captured from the customer’s account. UpdatePaymentIntentPaymentMethodOptionsSepaDebitSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsSofortPreferredLanguage Language shown to the payer on redirect. UpdatePaymentIntentPaymentMethodOptionsSofortSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsSwishSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsTwintSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersAccountSubcategories The account subcategories to use to filter for selectable accounts.
Valid subcategories are checking and savings. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions The list of permissions to request.
If this parameter is passed, the payment_method permission must be included.
Valid permissions include: balances, ownership, payment_method, and transactions. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch List of data features that you would like to retrieve upon account creation. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod The method used to collect offline mandate customer acceptance. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountNetworksRequested Triggers validations to run across the selected networks UpdatePaymentIntentPaymentMethodOptionsUsBankAccountPreferredSettlementSpeed Preferred transaction settlement speed UpdatePaymentIntentPaymentMethodOptionsUsBankAccountSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsUsBankAccountVerificationMethod Bank account verification method. UpdatePaymentIntentPaymentMethodOptionsWechatPayClient The client type that the end customer will pay from UpdatePaymentIntentPaymentMethodOptionsWechatPaySetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method. UpdatePaymentIntentPaymentMethodOptionsZipSetupFutureUsage Indicates that you intend to make future payments with this PaymentIntent’s payment method.