Update a PaymentIntent 

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Parameters

• amountinteger

  Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• customerstring

  ID of the Customer this PaymentIntent belongs to, if one exists.

  Payment methods attached to other Customers cannot be used with this PaymentIntent.

  If setup_future_usage is set and this PaymentIntent’s payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn’t a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

• descriptionstring

  An arbitrary string attached to the object. Often useful for displaying to users.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

• payment_methodstring

  ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.

• receipt_emailstring

  Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

• setup_future_usageenum

  Indicates that you intend to make future payments with this PaymentIntent’s payment method.

  If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

  If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

  When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

  If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

  Possible enum values

  off_session Use off_session if your customer may or may not be present in your checkout flow.

  on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

• shippingobject

  Shipping information for this PaymentIntent.

  Hide child parameters

  • shipping.addressobjectRequired

    Shipping address.

    Hide child parameters

    • shipping.address.citystring

      City, district, suburb, town, or village.

    • shipping.address.countrystringRequired for calculating taxes

      Two-letter country code (ISO 3166-1 alpha-2).

    • shipping.address.line1string

      Address line 1 (e.g., street, PO Box, or company name).

    • shipping.address.line2string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • shipping.address.postal_codestringRequired for calculating taxes

      ZIP or postal code.

    • shipping.address.statestring

      State, county, province, or region.

  • shipping.namestringRequired

    Recipient name.

  • shipping.carrierstring

    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

  • shipping.phonestring

    Recipient phone (including extension).

  • shipping.tracking_numberstring

    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

• statement_descriptorstring

  Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

  Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

• statement_descriptor_suffixstring

  Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

More parameters

Collapse all

• application_fee_amountintegerConnect only

  The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

• capture_methodenumsecret key only

  Controls when the funds will be captured from the customer’s account.

  Possible enum values

  automatic Stripe automatically captures funds when the customer authorizes the payment.

  automatic_async (Default) Stripe asynchronously captures funds when the customer authorizes the payment. Recommended over capture_method=automatic due to improved latency. Read the integration guide for more information.

  manual Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.)

• payment_method_configurationstring

  The ID of the payment method configuration to use with this PaymentIntent.

• payment_method_dataobject

  If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

  Hide child parameters

  • payment_method_data.typeenumRequired

    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.

  • payment_method_data.acss_debitobject

    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.

    Hide child parameters

    • payment_method_data.acss_debit.account_numberstringRequired

      Customer’s bank account number.

    • payment_method_data.acss_debit.institution_numberstringRequired

      Institution number of the customer’s bank.

    • payment_method_data.acss_debit.transit_numberstringRequired

      Transit number of the customer’s bank.

  • payment_method_data.affirmobject

    If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.

  • payment_method_data.afterpay_clearpayobject

    If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

  • payment_method_data.alipayobject

    If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.

  • payment_method_data.allow_redisplayenum

    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.

    Possible enum values

    always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

    limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

    unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

  • payment_method_data.almaobject

    If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.

  • payment_method_data.amazon_payobject

    If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

  • payment_method_data.au_becs_debitobject

    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.

    Hide child parameters

    • payment_method_data.au_becs_debit.account_numberstringRequired

      The account number for the bank account.

    • payment_method_data.au_becs_debit.bsb_numberstringRequired

      Bank-State-Branch number of the bank account.

  • payment_method_data.bacs_debitobject

    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

    Hide child parameters

    • payment_method_data.bacs_debit.account_numberstring

      Account number of the bank account that the funds will be debited from.

    • payment_method_data.bacs_debit.sort_codestring

      Sort code of the bank account. (e.g., 10-20-30)

  • payment_method_data.bancontactobject

    If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.

  • payment_method_data.billing_detailsobject

    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

    Hide child parameters

    • payment_method_data.billing_details.addressobject

      Billing address.

      Hide child parameters

      • payment_method_data.billing_details.address.citystring

        City, district, suburb, town, or village.

      • payment_method_data.billing_details.address.countrystring

        Two-letter country code (ISO 3166-1 alpha-2).

      • payment_method_data.billing_details.address.line1string

        Address line 1 (e.g., street, PO Box, or company name).

      • payment_method_data.billing_details.address.line2string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • payment_method_data.billing_details.address.postal_codestring

        ZIP or postal code.

      • payment_method_data.billing_details.address.statestring

        State, county, province, or region.

    • payment_method_data.billing_details.emailstring

      Email address.

    • payment_method_data.billing_details.namestring

      Full name.

    • payment_method_data.billing_details.phonestring

      Billing phone number (including extension).

  • payment_method_data.blikobject

    If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.

  • payment_method_data.boletoobject

    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.

    Hide child parameters

    • payment_method_data.boleto.tax_idstringRequired

      The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)

  • payment_method_data.cashappobject

    If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.

  • payment_method_data.customer_balanceobject

    If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.

  • payment_method_data.epsobject

    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.

    Hide child parameters

    • payment_method_data.eps.bankstring

      The customer’s bank.

  • payment_method_data.fpxobject

    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.

    Hide child parameters

    • payment_method_data.fpx.bankstringRequired

      The customer’s bank.

  • payment_method_data.giropayobject

    If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.

  • payment_method_data.grabpayobject

    If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.

  • payment_method_data.idealobject

    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

    Hide child parameters

    • payment_method_data.ideal.bankstring

      The customer’s bank. Only use this parameter for existing customers. Don’t use it for new customers.

  • payment_method_data.interac_presentobjectPreview feature

    If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.

  • payment_method_data.kakao_payobject

    If this is a kakao_pay PaymentMethod, this hash contains details about the Kakao Pay payment method.

  • payment_method_data.klarnaobject

    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.

    Hide child parameters

    • payment_method_data.klarna.dobobject

      Customer’s date of birth

      Hide child parameters

      • payment_method_data.klarna.dob.dayintegerRequired

        The day of birth, between 1 and 31.

      • payment_method_data.klarna.dob.monthintegerRequired

        The month of birth, between 1 and 12.

      • payment_method_data.klarna.dob.yearintegerRequired

        The four-digit year of birth.

  • payment_method_data.konbiniobject

    If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.

  • payment_method_data.kr_cardobject

    If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.

  • payment_method_data.linkobject

    If this is an Link PaymentMethod, this hash contains details about the Link payment method.

  • payment_method_data.metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • payment_method_data.mobilepayobject

    If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.

  • payment_method_data.multibancoobject

    If this is a multibanco PaymentMethod, this hash contains details about the Multibanco payment method.

  • payment_method_data.naver_payobject

    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.

    Hide child parameters

    • payment_method_data.naver_pay.fundingenum

      Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.

      Possible enum values

      card Use a card to fund this transaction.

      points Use Naver Pay points to fund this transaction.

  • payment_method_data.nz_bank_accountobjectPreview feature

    If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.

    Hide child parameters

    • payment_method_data.nz_bank_account.account_numberstringRequired

      The account number for the bank account.

    • payment_method_data.nz_bank_account.bank_codestringRequired

      The numeric code for the bank account’s bank.

    • payment_method_data.nz_bank_account.branch_codestringRequired

      The numeric code for the bank account’s bank branch.

    • payment_method_data.nz_bank_account.suffixstringRequired

      The suffix of the bank account number.

    • payment_method_data.nz_bank_account.account_holder_namestring

      The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.

  • payment_method_data.oxxoobject

    If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.

  • payment_method_data.p24object

    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.

    Hide child parameters

    • payment_method_data.p24.bankenum

      The customer’s bank.

  • payment_method_data.paycoobject

    If this is a payco PaymentMethod, this hash contains details about the PAYCO payment method.

  • payment_method_data.paynowobject

    If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.

  • payment_method_data.paypalobject

    If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.

  • payment_method_data.paypayobjectPreview feature

    If this is a paypay PaymentMethod, this hash contains details about the paypay payment method.

  • payment_method_data.pixobject

    If this is a pix PaymentMethod, this hash contains details about the Pix payment method.

  • payment_method_data.promptpayobject

    If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.

  • payment_method_data.radar_optionsobject

    Options to configure Radar. See Radar Session for more information.

    Hide child parameters

    • payment_method_data.radar_options.sessionstringsecret key only

      A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

  • payment_method_data.revolut_payobject

    If this is a Revolut Pay PaymentMethod, this hash contains details about the Revolut Pay payment method.

  • payment_method_data.samsung_payobject

    If this is a samsung_pay PaymentMethod, this hash contains details about the SamsungPay payment method.

  • payment_method_data.sepa_debitobject

    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

    Hide child parameters

    • payment_method_data.sepa_debit.ibanstringRequired

      IBAN of the bank account.

  • payment_method_data.sofortobject

    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

    Hide child parameters

    • payment_method_data.sofort.countryenumRequired

      Two-letter ISO code representing the country the bank account is located in.

      Possible enum values

      AT Austria

      BE Belgium

      DE Germany

      ES Spain

      IT Italy

      NL Netherlands

  • payment_method_data.swishobject

    If this is a swish PaymentMethod, this hash contains details about the Swish payment method.

  • payment_method_data.twintobject

    If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

  • payment_method_data.us_bank_accountobject

    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

    Hide child parameters

    • payment_method_data.us_bank_account.account_holder_typeenum

      Account holder type: individual or company.

      Possible enum values

      company Account belongs to a company

      individual Account belongs to an individual

    • payment_method_data.us_bank_account.account_numberstring

      Account number of the bank account.

    • payment_method_data.us_bank_account.account_typeenum

      Account type: checkings or savings. Defaults to checking if omitted.

      Possible enum values

      checking Bank account type is checking

      savings Bank account type is savings

    • payment_method_data.us_bank_account.financial_connections_accountstring

      The ID of a Financial Connections Account to use as a payment method.

    • payment_method_data.us_bank_account.routing_numberstring

      Routing number of the bank account.

  • payment_method_data.wechat_payobject

    If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.

  • payment_method_data.zipobject

    If this is a zip PaymentMethod, this hash contains details about the Zip payment method.

• payment_method_optionsobject

  Payment-method-specific configuration for this PaymentIntent.

  Hide child parameters

  • payment_method_options.acss_debitobject

    If this is a acss_debit PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.

    Hide child parameters

    • payment_method_options.acss_debit.mandate_optionsobject

      Additional fields for Mandate creation

      Hide child parameters

      • payment_method_options.acss_debit.mandate_options.custom_mandate_urlstring

        A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters payment_intent and payment_intent_client_secret when confirming a Payment Intent, or setup_intent and setup_intent_client_secret when confirming a Setup Intent.

      • payment_method_options.acss_debit.mandate_options.interval_descriptionstring

        Description of the mandate interval. Only required if ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.

      • payment_method_options.acss_debit.mandate_options.payment_scheduleenum

        Payment schedule for the mandate.

        Possible enum values

        combined Payments can be initiated at a pre-defined interval or sporadically

        interval Payments are initiated at a regular pre-defined interval

        sporadic Payments are initiated sporadically

      • payment_method_options.acss_debit.mandate_options.transaction_typeenum

        Transaction type of the mandate.

        Possible enum values

        business Transactions are made for business reasons

        personal Transactions are made for personal reasons

    • payment_method_options.acss_debit.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.acss_debit.verification_methodenum

      Bank account verification method.

      Possible enum values

      automatic Instant verification with fallback to microdeposits.

      instant Instant verification.

      microdeposits Verification using microdeposits.

  • payment_method_options.affirmobject

    If this is an affirm PaymentMethod, this sub-hash contains details about the Affirm payment method options.

    Hide child parameters

    • payment_method_options.affirm.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.affirm.preferred_localestring

      Preferred language of the Affirm authorization page that the customer is redirected to.

    • payment_method_options.affirm.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.afterpay_clearpayobject

    If this is a afterpay_clearpay PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.

    Hide child parameters

    • payment_method_options.afterpay_clearpay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.afterpay_clearpay.referencestring

      An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name.

    • payment_method_options.afterpay_clearpay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.alipayobject

    If this is a alipay PaymentMethod, this sub-hash contains details about the Alipay payment method options.

    Hide child parameters

    • payment_method_options.alipay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.almaobject

    If this is a alma PaymentMethod, this sub-hash contains details about the Alma payment method options.

    Hide child parameters

    • payment_method_options.alma.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.amazon_payobject

    If this is a amazon_pay PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.

    Hide child parameters

    • payment_method_options.amazon_pay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.amazon_pay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.au_becs_debitobject

    If this is a au_becs_debit PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.

    Hide child parameters

    • payment_method_options.au_becs_debit.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.bacs_debitobject

    If this is a bacs_debit PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.

    Hide child parameters

    • payment_method_options.bacs_debit.mandate_optionsobject

      Additional fields for Mandate creation

      Hide child parameters

      • payment_method_options.bacs_debit.mandate_options.reference_prefixstringPreview feature

        Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘DDIC’ or ‘STRIPE’.

    • payment_method_options.bacs_debit.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.bancontactobject

    If this is a bancontact PaymentMethod, this sub-hash contains details about the Bancontact payment method options.

    Hide child parameters

    • payment_method_options.bancontact.preferred_languageenum

      Preferred language of the Bancontact authorization page that the customer is redirected to.

      Possible enum values

      de German

      en English

      fr French

      nl Dutch

    • payment_method_options.bancontact.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.blikobject

    If this is a blik PaymentMethod, this sub-hash contains details about the BLIK payment method options.

    Hide child parameters

    • payment_method_options.blik.codestring

      The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.

    • payment_method_options.blik.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.boletoobject

    If this is a boleto PaymentMethod, this sub-hash contains details about the Boleto payment method options.

    Hide child parameters

    • payment_method_options.boleto.expires_after_daysinteger

      The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.

    • payment_method_options.boleto.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.cardobject

    Configuration for any card payments attempted on this PaymentIntent.

    Hide child parameters

    • payment_method_options.card.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.card.cvc_tokenstring

      A single-use cvc_update Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.

    • payment_method_options.card.installmentsobject

      Installment configuration for payments attempted on this PaymentIntent (Mexico Only).

      For more information, see the installments integration guide.

      Hide child parameters

      • payment_method_options.card.installments.enabledboolean

        Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. Setting to false will prevent any selected plan from applying to a charge.

      • payment_method_options.card.installments.planobject

        The selected installment plan to use for this payment attempt. This parameter can only be provided during confirmation.

        Hide child parameters

        • payment_method_options.card.installments.plan.typeenumRequired

          Type of installment plan, one of fixed_count.

          Possible enum values

          fixed_count

        • payment_method_options.card.installments.plan.countinteger

          For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.

        • payment_method_options.card.installments.plan.intervalenum

          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.

          Possible enum values

          month

    • payment_method_options.card.mandate_optionsobject

      Configuration options for setting up an eMandate for cards issued in India.

      Hide child parameters

      • payment_method_options.card.mandate_options.amountintegerRequired

        Amount to be charged for future payments.

      • payment_method_options.card.mandate_options.amount_typeenumRequired

        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.

        Possible enum values

        fixed

        maximum

      • payment_method_options.card.mandate_options.intervalenumRequired

        Specifies payment frequency. One of day, week, month, year, or sporadic.

        Possible enum values

        day

        month

        sporadic

        week

        year

      • payment_method_options.card.mandate_options.referencestringRequired

        Unique identifier for the mandate or subscription.

      • payment_method_options.card.mandate_options.start_datetimestampRequired

        Start date of the mandate or subscription. Start date should not be lesser than yesterday.

      • payment_method_options.card.mandate_options.descriptionstring

        A description of the mandate or subscription that is meant to be displayed to the customer.

      • payment_method_options.card.mandate_options.end_datetimestamp

        End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.

      • payment_method_options.card.mandate_options.interval_countinteger

        The number of intervals between payments. For example, interval=month and interval_count=3 indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when interval=sporadic.

      • payment_method_options.card.mandate_options.supported_typesarray of enums

        Specifies the type of mandates supported. Possible values are india.

        Possible enum values

        india

    • payment_method_options.card.networkstring

      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.

    • payment_method_options.card.request_extended_authorizationenum

      Request ability to capture beyond the standard authorization validity window for this PaymentIntent.

      Possible enum values

      if_available Use if_available if you want to extend the capture window when eligible for extended authorization.

      never Use never if you don’t want to extend the capture window.

    • payment_method_options.card.request_incremental_authorizationenum

      Request ability to increment the authorization for this PaymentIntent.

      Possible enum values

      if_available Use if_available if you want to increment the authorization on the PaymentIntent when eligible.

      never Use never if you don’t want to increment the authorization on the PaymentIntent.

    • payment_method_options.card.request_multicaptureenum

      Request ability to make multiple captures for this PaymentIntent.

      Possible enum values

      if_available Use if_available if you want to use multicapture when eligible.

      never Use never if you don’t want to use multicapture.

    • payment_method_options.card.request_overcaptureenum

      Request ability to overcapture for this PaymentIntent.

      Possible enum values

      if_available Use if_available if you want to overcapture the payment when eligible.

      never Use never if you don’t want to overcapture the payment.

    • payment_method_options.card.request_three_d_secureenumadvanced

      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.

      Possible enum values

      any Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any additional input from the customer. 3DS will always be attempted if it is supported for the card, but Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

      automatic (Default) Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements.

      challenge Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

    • payment_method_options.card.require_cvc_recollectionboolean

      When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).

    • payment_method_options.card.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.card.statement_descriptor_suffix_kanastring

      Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.

    • payment_method_options.card.statement_descriptor_suffix_kanjistring

      Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.

    • payment_method_options.card.three_d_secureobject

      If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.

      Hide child parameters

      • payment_method_options.card.three_d_secure.cryptogramstringRequired

        The cryptogram, also known as the “authentication value” (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. (Most 3D Secure providers will return the base64-encoded version, which is what you should specify here.)

      • payment_method_options.card.three_d_secure.transaction_idstringRequired

        For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).

      • payment_method_options.card.three_d_secure.versionenumRequired

        The version of 3D Secure that was performed.

      • payment_method_options.card.three_d_secure.ares_trans_statusenum

        The transStatus returned from the card Issuer’s ACS in the ARes.

        Possible enum values

        A Attempts processing performed; Not authenticated/verified, but a proof of attempted authentication/verification is provided.

        C Challenge required; Additional authentication is required.

        I Informational only; 3DS Requestor challenge preference acknowledged.

        N Not authenticated/Account not verified; Transaction denied.

        R Authentication/Account verification rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted.

        U Authentication/Account verification could not be performed; Technical or other problem.

        Y Authentication verification successful.

      • payment_method_options.card.three_d_secure.electronic_commerce_indicatorenumRequired on all networks except cartes bancaires

        The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.

        Possible enum values

        01 Mastercard variant: Attempt acknowledged.

        02 Mastercard variant: Fully authenticated.

        05 Fully authenticated. The customer likely proved their identity to the issuing bank.

        06 Attempt acknowledged. The customer, or the entire issuing bank, is not set up for 3D Secure. Or the issuing bank is experiencing an outage. Mastercard variant: Acquirer SCA exemption.

        07 Mastercard variant: Fully authenticated recurring transaction.

      • payment_method_options.card.three_d_secure.exemption_indicatorenum

        The exemption requested via 3DS and accepted by the issuer at authentication time.

        Possible enum values

        low_risk Transaction Risk Analysis (TRA) was performed, a low risk exemption was requested via 3DS and granted by the issuer.

        none No exemption was requested via 3DS; or, if requested, it was not granted by the issuer.

      • payment_method_options.card.three_d_secure.network_optionsobject

        Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly

        Hide child parameters

        • payment_method_options.card.three_d_secure.network_options.cartes_bancairesobject

          Cartes Bancaires-specific 3DS fields.

          Hide child parameters

          • payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgoenumRequired

            The cryptogram calculation algorithm used by the card Issuer’s ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO

            Possible enum values

            0 HMAC

            1 CVV

            2 CVV with ATN

            3 Mastercard SPA

            4 American Express SafeKey 1

            A AV-CB

          • payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemptionstring

            The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded

          • payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_scoreinteger

            The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99

      • payment_method_options.card.three_d_secure.requestor_challenge_indicatorstring

        The challenge indicator (threeDSRequestorChallengeInd) which was requested in the AReq sent to the card Issuer’s ACS. A string containing 2 digits from 01-99.

  • payment_method_options.card_presentobject

    If this is a card_present PaymentMethod, this sub-hash contains details about the Card Present payment method options.

    Hide child parameters

    • payment_method_options.card_present.capture_methodenumPreview feature

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

      manual_preferred Use manual_preferred if you prefer manual capture_method but support falling back to automatic based on the presented payment method.

    • payment_method_options.card_present.request_extended_authorizationboolean

      Request ability to capture this payment beyond the standard authorization validity window

    • payment_method_options.card_present.request_incremental_authorization_supportboolean

      Request ability to increment this PaymentIntent if the combination of MCC and card brand is eligible. Check incremental_authorization_supported in the Confirm response to verify support.

    • payment_method_options.card_present.routingobject

      Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

      Hide child parameters

      • payment_method_options.card_present.routing.requested_priorityenum

        Routing requested priority

        Possible enum values

        domestic Prioritize domestic debit network routing on payment method collection

        international Prioritize international network routing on payment method collection

  • payment_method_options.cashappobject

    If this is a cashapp PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.

    Hide child parameters

    • payment_method_options.cashapp.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.cashapp.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.customer_balanceobject

    If this is a customer balance PaymentMethod, this sub-hash contains details about the customer balance payment method options.

    Hide child parameters

    • payment_method_options.customer_balance.bank_transferobject

      Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

      Hide child parameters

      • payment_method_options.customer_balance.bank_transfer.typeenumRequired

        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.

        Possible enum values

        eu_bank_transfer eu_bank_transfer bank transfer type

        gb_bank_transfer gb_bank_transfer bank transfer type

        jp_bank_transfer jp_bank_transfer bank transfer type

        mx_bank_transfer mx_bank_transfer bank transfer type

        us_bank_transfer us_bank_transfer bank transfer type

      • payment_method_options.customer_balance.bank_transfer.eu_bank_transferobject

        Configuration for the eu_bank_transfer funding type.

        Hide child parameters

        • payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.countrystringRequired

          The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.

      • payment_method_options.customer_balance.bank_transfer.requested_address_typesarray of enums

        List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.

        Permitted values include: sort_code, zengin, iban, or spei.

        Possible enum values

        aba aba bank account address type

        iban iban bank account address type

        sepa sepa bank account address type

        sort_code sort_code bank account address type

        spei spei bank account address type

        swift swift bank account address type

        zengin zengin bank account address type

    • payment_method_options.customer_balance.funding_typeenum

      The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

      Possible enum values

      bank_transfer

    • payment_method_options.customer_balance.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.epsobject

    If this is a eps PaymentMethod, this sub-hash contains details about the EPS payment method options.

    Hide child parameters

    • payment_method_options.eps.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.fpxobject

    If this is a fpx PaymentMethod, this sub-hash contains details about the FPX payment method options.

    Hide child parameters

    • payment_method_options.fpx.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.giropayobject

    If this is a giropay PaymentMethod, this sub-hash contains details about the Giropay payment method options.

    Hide child parameters

    • payment_method_options.giropay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.grabpayobject

    If this is a grabpay PaymentMethod, this sub-hash contains details about the Grabpay payment method options.

    Hide child parameters

    • payment_method_options.grabpay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.idealobject

    If this is a ideal PaymentMethod, this sub-hash contains details about the Ideal payment method options.

    Hide child parameters

    • payment_method_options.ideal.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.interac_presentobjectPreview feature

    If this is a interac_present PaymentMethod, this sub-hash contains details about the Card Present payment method options.

  • payment_method_options.kakao_payobject

    If this is a kakao_pay PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.

    Hide child parameters

    • payment_method_options.kakao_pay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.kakao_pay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.klarnaobject

    If this is a klarna PaymentMethod, this sub-hash contains details about the Klarna payment method options.

    Hide child parameters

    • payment_method_options.klarna.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.klarna.preferred_localeenum

      Preferred language of the Klarna authorization page that the customer is redirected to

      Possible enum values

      cs-CZ Czech - Czechia

      da-DK Danish - Denmark

      de-AT German - Austria

      de-CH German - Switzerland

      de-DE German - Germany

      el-GR Greek - Greece

      en-AT English - Austria

      en-AU English - Australia

      en-BE English - Belgium

      en-CA English - Canada

      Show 36 more

    • payment_method_options.klarna.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.konbiniobject

    If this is a konbini PaymentMethod, this sub-hash contains details about the Konbini payment method options.

    Hide child parameters

    • payment_method_options.konbini.confirmation_numberstring

      An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer’s phone number.

    • payment_method_options.konbini.expires_after_daysinteger

      The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and expires_after_days set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.

    • payment_method_options.konbini.expires_attimestamp

      The timestamp at which the Konbini payment instructions will expire. Only one of expires_after_days or expires_at may be set.

    • payment_method_options.konbini.product_descriptionstring

      A product descriptor of up to 22 characters, which will appear to customers at the convenience store.

    • payment_method_options.konbini.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.kr_cardobject

    If this is a kr_card PaymentMethod, this sub-hash contains details about the KR Card payment method options.

    Hide child parameters

    • payment_method_options.kr_card.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.kr_card.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.linkobject

    If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options.

    Hide child parameters

    • payment_method_options.link.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.link.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.mobilepayobject

    If this is a MobilePay PaymentMethod, this sub-hash contains details about the MobilePay payment method options.

    Hide child parameters

    • payment_method_options.mobilepay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.mobilepay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.multibancoobject

    If this is a multibanco PaymentMethod, this sub-hash contains details about the Multibanco payment method options.

    Hide child parameters

    • payment_method_options.multibanco.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.naver_payobject

    If this is a naver_pay PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.

    Hide child parameters

    • payment_method_options.naver_pay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.nz_bank_accountobjectPreview feature

    If this is a nz_bank_account PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.

    Hide child parameters

    • payment_method_options.nz_bank_account.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.oxxoobject

    If this is a oxxo PaymentMethod, this sub-hash contains details about the OXXO payment method options.

    Hide child parameters

    • payment_method_options.oxxo.expires_after_daysinteger

      The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.

    • payment_method_options.oxxo.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.p24object

    If this is a p24 PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.

    Hide child parameters

    • payment_method_options.p24.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

    • payment_method_options.p24.tos_shown_and_acceptedboolean

      Confirm that the payer has accepted the P24 terms and conditions.

  • payment_method_options.paycoobject

    If this is a payco PaymentMethod, this sub-hash contains details about the PAYCO payment method options.

    Hide child parameters

    • payment_method_options.payco.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.paynowobject

    If this is a paynow PaymentMethod, this sub-hash contains details about the PayNow payment method options.

    Hide child parameters

    • payment_method_options.paynow.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.paypalobject

    If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options.

    Hide child parameters

    • payment_method_options.paypal.capture_methodenum

      Controls when the funds will be captured from the customer’s account.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.paypal.preferred_localeenum

      Preferred locale of the PayPal checkout page that the customer is redirected to.

      Possible enum values

      cs-CZ Czech - The Czech Republic

      da-DK Danish - Denmark

      de-AT German - Austria

      de-DE German - Germany

      de-LU German - Luxembourg

      el-GR Greek - Greece

      en-GB English - United Kingdom

      en-US English - United States of America

      es-ES Spanish - Spain

      fi-FI Finnish - Finland

      Show 11 more

    • payment_method_options.paypal.referencestring

      A reference of the PayPal transaction visible to customer which is mapped to PayPal’s invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.

    • payment_method_options.paypal.risk_correlation_idstring

      The risk correlation ID for an on-session payment using a saved PayPal payment method.

    • payment_method_options.paypal.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.pixobject

    If this is a pix PaymentMethod, this sub-hash contains details about the Pix payment method options.

    Hide child parameters

    • payment_method_options.pix.expires_after_secondsinteger

      The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.

    • payment_method_options.pix.expires_attimestamp

      The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.

    • payment_method_options.pix.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.promptpayobject

    If this is a promptpay PaymentMethod, this sub-hash contains details about the PromptPay payment method options.

    Hide child parameters

    • payment_method_options.promptpay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.revolut_payobject

    If this is a revolut_pay PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.

    Hide child parameters

    • payment_method_options.revolut_pay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.revolut_pay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.samsung_payobject

    If this is a samsung_pay PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.

    Hide child parameters

    • payment_method_options.samsung_pay.capture_methodenum

      Controls when the funds are captured from the customer’s account.

      If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.

      If capture_method is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.

      Possible enum values

      manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.sepa_debitobject

    If this is a sepa_debit PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.

    Hide child parameters

    • payment_method_options.sepa_debit.mandate_optionsobject

      Additional fields for Mandate creation

      Hide child parameters

      • payment_method_options.sepa_debit.mandate_options.reference_prefixstringPreview feature

        Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘STRIPE’.

    • payment_method_options.sepa_debit.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.sofortobject

    If this is a sofort PaymentMethod, this sub-hash contains details about the SOFORT payment method options.

    Hide child parameters

    • payment_method_options.sofort.preferred_languageenum

      Language shown to the payer on redirect.

      Possible enum values

      de German

      en English

      es Spanish

      fr French

      it Italian

      nl Dutch

      pl Polish

    • payment_method_options.sofort.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.swishobject

    If this is a Swish PaymentMethod, this sub-hash contains details about the Swish payment method options.

    Hide child parameters

    • payment_method_options.swish.referencestring

      A reference for this payment to be displayed in the Swish app.

    • payment_method_options.swish.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.twintobject

    If this is a twint PaymentMethod, this sub-hash contains details about the TWINT payment method options.

    Hide child parameters

    • payment_method_options.twint.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.us_bank_accountobject

    If this is a us_bank_account PaymentMethod, this sub-hash contains details about the US bank account payment method options.

    Hide child parameters

    • payment_method_options.us_bank_account.financial_connectionsobject

      Additional fields for Financial Connections Session creation

      Hide child parameters

      • payment_method_options.us_bank_account.financial_connections.filtersobject

        Provide filters for the linked accounts that the customer can select for the payment method.

        Hide child parameters

        • payment_method_options.us_bank_account.financial_connections.filters.account_subcategoriesarray of strings

          The account subcategories to use to filter for selectable accounts. Valid subcategories are checking and savings.

      • payment_method_options.us_bank_account.financial_connections.permissionsarray of strings

        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.

      • payment_method_options.us_bank_account.financial_connections.prefetcharray of enums

        List of data features that you would like to retrieve upon account creation.

        Possible enum values

        balances Requests to prefetch balance data on accounts collected in this session.

        ownership Requests to prefetch ownership data on accounts collected in this session.

        transactions Requests to prefetch transaction data on accounts collected in this session.

      • payment_method_options.us_bank_account.financial_connections.return_urlstring

        For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

    • payment_method_options.us_bank_account.mandate_optionsobject

      Additional fields for Mandate creation

      Hide child parameters

      • payment_method_options.us_bank_account.mandate_options.collection_methodenum

        The method used to collect offline mandate customer acceptance.

        Possible enum values

        paper Mandate customer acceptance was collected using a paper document

    • payment_method_options.us_bank_account.networksobject

      Additional fields for network related functions

      Hide child parameters

      • payment_method_options.us_bank_account.networks.requestedarray of enums

        Triggers validations to run across the selected networks

        Possible enum values

        ach

        us_domestic_wire

    • payment_method_options.us_bank_account.preferred_settlement_speedenum

      Preferred transaction settlement speed

      Possible enum values

      fastest Prefer fastest available settlement

      standard Prefer standard settlement

    • payment_method_options.us_bank_account.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      off_session Use off_session if your customer may or may not be present in your checkout flow.

      on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.us_bank_account.verification_methodenum

      Bank account verification method.

      Possible enum values

      automatic Instant verification with fallback to microdeposits.

      instant Instant verification only.

      microdeposits Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.

  • payment_method_options.wechat_payobject

    If this is a wechat_pay PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.

    Hide child parameters

    • payment_method_options.wechat_pay.clientenumRequired

      The client type that the end customer will pay from

      Possible enum values

      android The end customer will pay from an Android app

      ios The end customer will pay from an iOS app

      web The end customer will pay from web browser

    • payment_method_options.wechat_pay.app_idstring

      The app ID registered with WeChat Pay. Only required when client is ios or android.

    • payment_method_options.wechat_pay.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.zipobject

    If this is a zip PaymentMethod, this sub-hash contains details about the Zip payment method options.

    Hide child parameters

    • payment_method_options.zip.setup_future_usageenum

      Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

      Possible enum values

      none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

• payment_method_typesarray of strings

  The list of payment method types (for example, card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard.

• transfer_dataobjectConnect only

  Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the use case for connected accounts.

  Hide child parameters

  • transfer_data.amountinteger

    The amount that will be transferred automatically when a charge succeeds.

• transfer_groupstringConnect only

  A string that identifies the resulting payment as part of a group. You can only provide transfer_group if it hasn’t been set. Learn more about the use case for connected accounts.