Module setup_intent Copy item path Source BillingDetailsAddress BillingDetailsInnerParams CancelSetupIntent You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. ConfirmSetupIntent Confirm that your customer intends to set up the current or
provided payment method. For example, you would confirm a SetupIntent
when a customer hits the “Save” button on a payment method management
page on your website. ConfirmSetupIntentClientKeyParam ConfirmSetupIntentClientKeyParamCustomerAcceptance This hash contains details about the customer acceptance of the Mandate. ConfirmSetupIntentClientKeyParamCustomerAcceptanceOnline If this is a Mandate accepted online, this hash contains details about the online acceptance. ConfirmSetupIntentPaymentMethodData When included, this hash creates a PaymentMethod that is set as the payment_method ConfirmSetupIntentPaymentMethodDataAuBecsDebit If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account. ConfirmSetupIntentPaymentMethodDataBacsDebit If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. ConfirmSetupIntentPaymentMethodDataBoleto If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method. ConfirmSetupIntentPaymentMethodDataEps If this is an eps PaymentMethod, this hash contains details about the EPS payment method. ConfirmSetupIntentPaymentMethodDataFpx If this is an fpx PaymentMethod, this hash contains details about the FPX payment method. ConfirmSetupIntentPaymentMethodDataIdeal If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method. ConfirmSetupIntentPaymentMethodDataKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method. ConfirmSetupIntentPaymentMethodDataNaverPay If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method. ConfirmSetupIntentPaymentMethodDataNzBankAccount If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. ConfirmSetupIntentPaymentMethodDataP24 If this is a p24 PaymentMethod, this hash contains details about the P24 payment method. ConfirmSetupIntentPaymentMethodDataPayto If this is a payto PaymentMethod, this hash contains details about the PayTo payment method. ConfirmSetupIntentPaymentMethodDataSepaDebit If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account. ConfirmSetupIntentPaymentMethodDataSofort If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method. ConfirmSetupIntentPaymentMethodDataUsBankAccount If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method. ConfirmSetupIntentPaymentMethodOptions Payment method-specific configuration for this SetupIntent. ConfirmSetupIntentPaymentMethodOptionsAcssDebit If this is a acss_debit SetupIntent, this sub-hash contains details about the ACSS Debit payment method options. ConfirmSetupIntentPaymentMethodOptionsAcssDebitMandateOptions Additional fields for Mandate creation ConfirmSetupIntentPaymentMethodOptionsBacsDebit If this is a bacs_debit SetupIntent, this sub-hash contains details about the Bacs Debit payment method options. ConfirmSetupIntentPaymentMethodOptionsCard Configuration for any card setup attempted on this SetupIntent. ConfirmSetupIntentPaymentMethodOptionsCardMandateOptions Configuration options for setting up an eMandate for cards issued in India. ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecure If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this setup. ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires Cartes Bancaires-specific 3DS fields. ConfirmSetupIntentPaymentMethodOptionsKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method options. ConfirmSetupIntentPaymentMethodOptionsKlarnaOnDemand On-demand details if setting up a payment method for on-demand payments. ConfirmSetupIntentPaymentMethodOptionsKlarnaSubscriptions Subscription details if setting up or charging a subscription ConfirmSetupIntentPaymentMethodOptionsPayto If this is a payto SetupIntent, this sub-hash contains details about the PayTo payment method options. ConfirmSetupIntentPaymentMethodOptionsPaytoMandateOptions Additional fields for Mandate creation. ConfirmSetupIntentPaymentMethodOptionsSepaDebit If this is a sepa_debit SetupIntent, this sub-hash contains details about the SEPA Debit payment method options. ConfirmSetupIntentPaymentMethodOptionsSepaDebitMandateOptions Additional fields for Mandate creation ConfirmSetupIntentPaymentMethodOptionsUsBankAccount If this is a us_bank_account SetupIntent, this sub-hash contains details about the US bank account payment method options. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnections Additional fields for Financial Connections Session creation ConfirmSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Provide filters for the linked accounts that the customer can select for the payment method. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountMandateOptions Additional fields for Mandate creation ConfirmSetupIntentPaymentMethodOptionsUsBankAccountNetworks Additional fields for network related functions ConfirmSetupIntentSecretKeyParam ConfirmSetupIntentSecretKeyParamCustomerAcceptance This hash contains details about the customer acceptance of the Mandate. CreateSetupIntent Creates a SetupIntent object. CreateSetupIntentAutomaticPaymentMethods When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters. CreateSetupIntentMandateData This hash contains details about the mandate to create.
This parameter can only be used with confirm=true CreateSetupIntentMandateDataCustomerAcceptance This hash contains details about the customer acceptance of the Mandate. CreateSetupIntentPaymentMethodData When included, this hash creates a PaymentMethod that is set as the payment_method CreateSetupIntentPaymentMethodDataAuBecsDebit If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account. CreateSetupIntentPaymentMethodDataBacsDebit If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. CreateSetupIntentPaymentMethodDataBoleto If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method. CreateSetupIntentPaymentMethodDataEps If this is an eps PaymentMethod, this hash contains details about the EPS payment method. CreateSetupIntentPaymentMethodDataFpx If this is an fpx PaymentMethod, this hash contains details about the FPX payment method. CreateSetupIntentPaymentMethodDataIdeal If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method. CreateSetupIntentPaymentMethodDataKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method. CreateSetupIntentPaymentMethodDataNaverPay If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method. CreateSetupIntentPaymentMethodDataNzBankAccount If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. CreateSetupIntentPaymentMethodDataP24 If this is a p24 PaymentMethod, this hash contains details about the P24 payment method. CreateSetupIntentPaymentMethodDataPayto If this is a payto PaymentMethod, this hash contains details about the PayTo payment method. CreateSetupIntentPaymentMethodDataSepaDebit If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account. CreateSetupIntentPaymentMethodDataSofort If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method. CreateSetupIntentPaymentMethodDataUsBankAccount If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method. CreateSetupIntentPaymentMethodOptions Payment method-specific configuration for this SetupIntent. CreateSetupIntentPaymentMethodOptionsAcssDebit If this is a acss_debit SetupIntent, this sub-hash contains details about the ACSS Debit payment method options. CreateSetupIntentPaymentMethodOptionsAcssDebitMandateOptions Additional fields for Mandate creation CreateSetupIntentPaymentMethodOptionsBacsDebit If this is a bacs_debit SetupIntent, this sub-hash contains details about the Bacs Debit payment method options. CreateSetupIntentPaymentMethodOptionsCard Configuration for any card setup attempted on this SetupIntent. CreateSetupIntentPaymentMethodOptionsCardMandateOptions Configuration options for setting up an eMandate for cards issued in India. CreateSetupIntentPaymentMethodOptionsCardThreeDSecure If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this setup. CreateSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly CreateSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires Cartes Bancaires-specific 3DS fields. CreateSetupIntentPaymentMethodOptionsKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method options. CreateSetupIntentPaymentMethodOptionsKlarnaOnDemand On-demand details if setting up a payment method for on-demand payments. CreateSetupIntentPaymentMethodOptionsKlarnaSubscriptions Subscription details if setting up or charging a subscription CreateSetupIntentPaymentMethodOptionsPayto If this is a payto SetupIntent, this sub-hash contains details about the PayTo payment method options. CreateSetupIntentPaymentMethodOptionsPaytoMandateOptions Additional fields for Mandate creation. CreateSetupIntentPaymentMethodOptionsSepaDebit If this is a sepa_debit SetupIntent, this sub-hash contains details about the SEPA Debit payment method options. CreateSetupIntentPaymentMethodOptionsSepaDebitMandateOptions Additional fields for Mandate creation CreateSetupIntentPaymentMethodOptionsUsBankAccount If this is a us_bank_account SetupIntent, this sub-hash contains details about the US bank account payment method options. CreateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnections Additional fields for Financial Connections Session creation CreateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Provide filters for the linked accounts that the customer can select for the payment method. CreateSetupIntentPaymentMethodOptionsUsBankAccountMandateOptions Additional fields for Mandate creation CreateSetupIntentPaymentMethodOptionsUsBankAccountNetworks Additional fields for network related functions CreateSetupIntentSingleUse If you populate this hash, this SetupIntent generates a single_use mandate after successful completion. DateOfBirth ListSetupIntent Returns a list of SetupIntents. OnlineParam PaymentMethodOptionsMandateOptionsParam PaymentMethodOptionsParam PaymentMethodParam RadarOptionsWithHiddenOptions RetrieveSetupIntent Retrieves the details of a SetupIntent that has previously been created. SetupIntentPaymentMethodOptionsParam SubscriptionNextBillingParam UpdateSetupIntent Updates a SetupIntent object. UpdateSetupIntentPaymentMethodData When included, this hash creates a PaymentMethod that is set as the payment_method UpdateSetupIntentPaymentMethodDataAuBecsDebit If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account. UpdateSetupIntentPaymentMethodDataBacsDebit If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. UpdateSetupIntentPaymentMethodDataBoleto If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method. UpdateSetupIntentPaymentMethodDataEps If this is an eps PaymentMethod, this hash contains details about the EPS payment method. UpdateSetupIntentPaymentMethodDataFpx If this is an fpx PaymentMethod, this hash contains details about the FPX payment method. UpdateSetupIntentPaymentMethodDataIdeal If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method. UpdateSetupIntentPaymentMethodDataKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method. UpdateSetupIntentPaymentMethodDataNaverPay If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method. UpdateSetupIntentPaymentMethodDataNzBankAccount If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. UpdateSetupIntentPaymentMethodDataP24 If this is a p24 PaymentMethod, this hash contains details about the P24 payment method. UpdateSetupIntentPaymentMethodDataPayto If this is a payto PaymentMethod, this hash contains details about the PayTo payment method. UpdateSetupIntentPaymentMethodDataSepaDebit If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account. UpdateSetupIntentPaymentMethodDataSofort If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method. UpdateSetupIntentPaymentMethodDataUsBankAccount If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method. UpdateSetupIntentPaymentMethodOptions Payment method-specific configuration for this SetupIntent. UpdateSetupIntentPaymentMethodOptionsAcssDebit If this is a acss_debit SetupIntent, this sub-hash contains details about the ACSS Debit payment method options. UpdateSetupIntentPaymentMethodOptionsAcssDebitMandateOptions Additional fields for Mandate creation UpdateSetupIntentPaymentMethodOptionsBacsDebit If this is a bacs_debit SetupIntent, this sub-hash contains details about the Bacs Debit payment method options. UpdateSetupIntentPaymentMethodOptionsCard Configuration for any card setup attempted on this SetupIntent. UpdateSetupIntentPaymentMethodOptionsCardMandateOptions Configuration options for setting up an eMandate for cards issued in India. UpdateSetupIntentPaymentMethodOptionsCardThreeDSecure If 3D Secure authentication was performed with a third-party provider,
the authentication details to use for this setup. UpdateSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions Network specific 3DS fields. Network specific arguments require an
explicit card brand choice. The parameter `payment_method_options.card.network``
must be populated accordingly UpdateSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires Cartes Bancaires-specific 3DS fields. UpdateSetupIntentPaymentMethodOptionsKlarna If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method options. UpdateSetupIntentPaymentMethodOptionsKlarnaOnDemand On-demand details if setting up a payment method for on-demand payments. UpdateSetupIntentPaymentMethodOptionsKlarnaSubscriptions Subscription details if setting up or charging a subscription UpdateSetupIntentPaymentMethodOptionsPayto If this is a payto SetupIntent, this sub-hash contains details about the PayTo payment method options. UpdateSetupIntentPaymentMethodOptionsPaytoMandateOptions Additional fields for Mandate creation. UpdateSetupIntentPaymentMethodOptionsSepaDebit If this is a sepa_debit SetupIntent, this sub-hash contains details about the SEPA Debit payment method options. UpdateSetupIntentPaymentMethodOptionsSepaDebitMandateOptions Additional fields for Mandate creation UpdateSetupIntentPaymentMethodOptionsUsBankAccount If this is a us_bank_account SetupIntent, this sub-hash contains details about the US bank account payment method options. UpdateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnections Additional fields for Financial Connections Session creation UpdateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters Provide filters for the linked accounts that the customer can select for the payment method. UpdateSetupIntentPaymentMethodOptionsUsBankAccountMandateOptions Additional fields for Mandate creation UpdateSetupIntentPaymentMethodOptionsUsBankAccountNetworks Additional fields for network related functions VerifyMicrodepositsSetupIntent Verifies microdeposits on a SetupIntent object. ConfirmSetupIntentClientKeyParamCustomerAcceptanceType The type of customer acceptance information included with the Mandate. ConfirmSetupIntentMandateData ConfirmSetupIntentPaymentMethodDataAllowRedisplay 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. ConfirmSetupIntentPaymentMethodDataEpsBank The customer’s bank. ConfirmSetupIntentPaymentMethodDataFpxAccountHolderType Account holder type for FPX transaction ConfirmSetupIntentPaymentMethodDataFpxBank The customer’s bank. ConfirmSetupIntentPaymentMethodDataIdealBank The customer’s bank.
Only use this parameter for existing customers.
Don’t use it for new customers. ConfirmSetupIntentPaymentMethodDataNaverPayFunding Whether to use Naver Pay points or a card to fund this transaction.
If not provided, this defaults to card. ConfirmSetupIntentPaymentMethodDataP24Bank The customer’s bank. ConfirmSetupIntentPaymentMethodDataSofortCountry Two-letter ISO code representing the country the bank account is located in. ConfirmSetupIntentPaymentMethodDataType 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. ConfirmSetupIntentPaymentMethodDataUsBankAccountAccountHolderType Account holder type: individual or company. ConfirmSetupIntentPaymentMethodDataUsBankAccountAccountType Account type: checkings or savings. Defaults to checking if omitted. ConfirmSetupIntentPaymentMethodOptionsAcssDebitCurrency Three-letter ISO currency code , in lowercase.
Must be a supported currency . ConfirmSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsDefaultFor List of Stripe products where this mandate can be selected automatically. ConfirmSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsPaymentSchedule Payment schedule for the mandate. ConfirmSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsTransactionType Transaction type of the mandate. ConfirmSetupIntentPaymentMethodOptionsAcssDebitVerificationMethod Bank account verification method. ConfirmSetupIntentPaymentMethodOptionsCardMandateOptionsAmountType 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. ConfirmSetupIntentPaymentMethodOptionsCardMandateOptionsInterval Specifies payment frequency. One of day, week, month, year, or sporadic. ConfirmSetupIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes Specifies the type of mandates supported. Possible values are india. ConfirmSetupIntentPaymentMethodOptionsCardNetwork Selected network to process this SetupIntent on.
Depends on the available networks of the card attached to the SetupIntent.
Can be only set confirm-time. ConfirmSetupIntentPaymentMethodOptionsCardRequestThreeDSecure 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. ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecureAresTransStatus The transStatus returned from the card Issuer’s ACS in the ARes. ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecureElectronicCommerceIndicator The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed. ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesCbAvalgo The cryptogram calculation algorithm used by the card Issuer’s ACS
to calculate the Authentication cryptogram. Also known as cavvAlgorithm.
messageExtension: CB-AVALGO ConfirmSetupIntentPaymentMethodOptionsCardThreeDSecureVersion The version of 3D Secure that was performed. ConfirmSetupIntentPaymentMethodOptionsKlarnaOnDemandPurchaseInterval Interval at which the customer is making purchases ConfirmSetupIntentPaymentMethodOptionsKlarnaPreferredLocale Preferred language of the Klarna authorization page that the customer is redirected to ConfirmSetupIntentPaymentMethodOptionsKlarnaSubscriptionsInterval Unit of time between subscription charges. ConfirmSetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType The type of amount that will be collected.
The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively.
Defaults to maximum. ConfirmSetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule The periodicity at which payments will be collected. Defaults to adhoc. ConfirmSetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose The purpose for which payments are made. Has a default value based on your merchant category code. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersAccountSubcategories The account subcategories to use to filter for selectable accounts.
Valid subcategories are checking and savings. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions 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. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch List of data features that you would like to retrieve upon account creation. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod The method used to collect offline mandate customer acceptance. ConfirmSetupIntentPaymentMethodOptionsUsBankAccountNetworksRequested Triggers validations to run across the selected networks ConfirmSetupIntentPaymentMethodOptionsUsBankAccountVerificationMethod Bank account verification method. ConfirmSetupIntentSecretKeyParamCustomerAcceptanceType The type of customer acceptance information included with the Mandate.
One of online or offline. CreateSetupIntentAutomaticPaymentMethodsAllowRedirects Controls whether this SetupIntent will accept redirect-based payment methods. CreateSetupIntentMandateDataCustomerAcceptanceType The type of customer acceptance information included with the Mandate.
One of online or offline. CreateSetupIntentPaymentMethodDataAllowRedisplay 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. CreateSetupIntentPaymentMethodDataEpsBank The customer’s bank. CreateSetupIntentPaymentMethodDataFpxAccountHolderType Account holder type for FPX transaction CreateSetupIntentPaymentMethodDataFpxBank The customer’s bank. CreateSetupIntentPaymentMethodDataIdealBank The customer’s bank.
Only use this parameter for existing customers.
Don’t use it for new customers. CreateSetupIntentPaymentMethodDataNaverPayFunding Whether to use Naver Pay points or a card to fund this transaction.
If not provided, this defaults to card. CreateSetupIntentPaymentMethodDataP24Bank The customer’s bank. CreateSetupIntentPaymentMethodDataSofortCountry Two-letter ISO code representing the country the bank account is located in. CreateSetupIntentPaymentMethodDataType 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. CreateSetupIntentPaymentMethodDataUsBankAccountAccountHolderType Account holder type: individual or company. CreateSetupIntentPaymentMethodDataUsBankAccountAccountType Account type: checkings or savings. Defaults to checking if omitted. CreateSetupIntentPaymentMethodOptionsAcssDebitCurrency Three-letter ISO currency code , in lowercase.
Must be a supported currency . CreateSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsDefaultFor List of Stripe products where this mandate can be selected automatically. CreateSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsPaymentSchedule Payment schedule for the mandate. CreateSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsTransactionType Transaction type of the mandate. CreateSetupIntentPaymentMethodOptionsAcssDebitVerificationMethod Bank account verification method. CreateSetupIntentPaymentMethodOptionsCardMandateOptionsAmountType 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. CreateSetupIntentPaymentMethodOptionsCardMandateOptionsInterval Specifies payment frequency. One of day, week, month, year, or sporadic. CreateSetupIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes Specifies the type of mandates supported. Possible values are india. CreateSetupIntentPaymentMethodOptionsCardNetwork Selected network to process this SetupIntent on.
Depends on the available networks of the card attached to the SetupIntent.
Can be only set confirm-time. CreateSetupIntentPaymentMethodOptionsCardRequestThreeDSecure 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. CreateSetupIntentPaymentMethodOptionsCardThreeDSecureAresTransStatus The transStatus returned from the card Issuer’s ACS in the ARes. CreateSetupIntentPaymentMethodOptionsCardThreeDSecureElectronicCommerceIndicator The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed. CreateSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesCbAvalgo The cryptogram calculation algorithm used by the card Issuer’s ACS
to calculate the Authentication cryptogram. Also known as cavvAlgorithm.
messageExtension: CB-AVALGO CreateSetupIntentPaymentMethodOptionsCardThreeDSecureVersion The version of 3D Secure that was performed. CreateSetupIntentPaymentMethodOptionsKlarnaOnDemandPurchaseInterval Interval at which the customer is making purchases CreateSetupIntentPaymentMethodOptionsKlarnaPreferredLocale Preferred language of the Klarna authorization page that the customer is redirected to CreateSetupIntentPaymentMethodOptionsKlarnaSubscriptionsInterval Unit of time between subscription charges. CreateSetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType The type of amount that will be collected.
The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively.
Defaults to maximum. CreateSetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule The periodicity at which payments will be collected. Defaults to adhoc. CreateSetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose The purpose for which payments are made. Has a default value based on your merchant category code. CreateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersAccountSubcategories The account subcategories to use to filter for selectable accounts.
Valid subcategories are checking and savings. CreateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions 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. CreateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch List of data features that you would like to retrieve upon account creation. CreateSetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod The method used to collect offline mandate customer acceptance. CreateSetupIntentPaymentMethodOptionsUsBankAccountNetworksRequested Triggers validations to run across the selected networks CreateSetupIntentPaymentMethodOptionsUsBankAccountVerificationMethod Bank account verification method. CreateSetupIntentUsage Indicates how the payment method is intended to be used in the future.
If not provided, this value defaults to off_session. UpdateSetupIntentPaymentMethodDataAllowRedisplay 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. UpdateSetupIntentPaymentMethodDataEpsBank The customer’s bank. UpdateSetupIntentPaymentMethodDataFpxAccountHolderType Account holder type for FPX transaction UpdateSetupIntentPaymentMethodDataFpxBank The customer’s bank. UpdateSetupIntentPaymentMethodDataIdealBank The customer’s bank.
Only use this parameter for existing customers.
Don’t use it for new customers. UpdateSetupIntentPaymentMethodDataNaverPayFunding Whether to use Naver Pay points or a card to fund this transaction.
If not provided, this defaults to card. UpdateSetupIntentPaymentMethodDataP24Bank The customer’s bank. UpdateSetupIntentPaymentMethodDataSofortCountry Two-letter ISO code representing the country the bank account is located in. UpdateSetupIntentPaymentMethodDataType 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. UpdateSetupIntentPaymentMethodDataUsBankAccountAccountHolderType Account holder type: individual or company. UpdateSetupIntentPaymentMethodDataUsBankAccountAccountType Account type: checkings or savings. Defaults to checking if omitted. UpdateSetupIntentPaymentMethodOptionsAcssDebitCurrency Three-letter ISO currency code , in lowercase.
Must be a supported currency . UpdateSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsDefaultFor List of Stripe products where this mandate can be selected automatically. UpdateSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsPaymentSchedule Payment schedule for the mandate. UpdateSetupIntentPaymentMethodOptionsAcssDebitMandateOptionsTransactionType Transaction type of the mandate. UpdateSetupIntentPaymentMethodOptionsAcssDebitVerificationMethod Bank account verification method. UpdateSetupIntentPaymentMethodOptionsCardMandateOptionsAmountType 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. UpdateSetupIntentPaymentMethodOptionsCardMandateOptionsInterval Specifies payment frequency. One of day, week, month, year, or sporadic. UpdateSetupIntentPaymentMethodOptionsCardMandateOptionsSupportedTypes Specifies the type of mandates supported. Possible values are india. UpdateSetupIntentPaymentMethodOptionsCardNetwork Selected network to process this SetupIntent on.
Depends on the available networks of the card attached to the SetupIntent.
Can be only set confirm-time. UpdateSetupIntentPaymentMethodOptionsCardRequestThreeDSecure 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. UpdateSetupIntentPaymentMethodOptionsCardThreeDSecureAresTransStatus The transStatus returned from the card Issuer’s ACS in the ARes. UpdateSetupIntentPaymentMethodOptionsCardThreeDSecureElectronicCommerceIndicator The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
provider and indicates what degree of authentication was performed. UpdateSetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesCbAvalgo The cryptogram calculation algorithm used by the card Issuer’s ACS
to calculate the Authentication cryptogram. Also known as cavvAlgorithm.
messageExtension: CB-AVALGO UpdateSetupIntentPaymentMethodOptionsCardThreeDSecureVersion The version of 3D Secure that was performed. UpdateSetupIntentPaymentMethodOptionsKlarnaOnDemandPurchaseInterval Interval at which the customer is making purchases UpdateSetupIntentPaymentMethodOptionsKlarnaPreferredLocale Preferred language of the Klarna authorization page that the customer is redirected to UpdateSetupIntentPaymentMethodOptionsKlarnaSubscriptionsInterval Unit of time between subscription charges. UpdateSetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType The type of amount that will be collected.
The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively.
Defaults to maximum. UpdateSetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule The periodicity at which payments will be collected. Defaults to adhoc. UpdateSetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose The purpose for which payments are made. Has a default value based on your merchant category code. UpdateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersAccountSubcategories The account subcategories to use to filter for selectable accounts.
Valid subcategories are checking and savings. UpdateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions 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. UpdateSetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch List of data features that you would like to retrieve upon account creation. UpdateSetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsCollectionMethod The method used to collect offline mandate customer acceptance. UpdateSetupIntentPaymentMethodOptionsUsBankAccountNetworksRequested Triggers validations to run across the selected networks UpdateSetupIntentPaymentMethodOptionsUsBankAccountVerificationMethod Bank account verification method.