Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks
Sandboxes

Create a SetupIntent 

Core Resources
Setup Intents
Create a SetupIntent

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

Parameters

  • automatic_payment_methodsobject

    When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.

    • automatic_payment_methods.enabledbooleanRequired

      Whether this feature is enabled.

    • automatic_payment_methods.allow_redirectsenum

      Controls whether this SetupIntent will accept redirect-based payment methods.

      Redirect-based payment methods may require your customer to be redirected to a payment method’s app or site for authentication or additional steps. To confirm this SetupIntent, you may be required to provide a return_url to redirect customers back to your site after they authenticate or complete the setup.

      Possible enum values
      always

      (Default) This SetupIntent will accept redirect-based payment methods. return_url may be required to confirm this SetupIntent.

      never

      This SetupIntent will not accept redirect-based payment methods. Payment methods that require redirect will be filtered. return_url will not be required to confirm this SetupIntent.

  • confirmboolean

    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.

  • customerstring

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

    If present, the SetupIntent’s payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

  • 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 saved Source object) to attach to this SetupIntent.

  • usageenum

    Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to off_session.

    Possible enum values
    off_session

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

    on_session

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

More parameters

  • attach_to_selfboolean

    If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.

    It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

  • confirmation_tokenstringonly when confirm=true

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

  • flow_directionsarray of enums

    Indicates the directions of money movement for which this payment method is intended to be used.

    Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

    Possible enum values
    inbound

    Set up an inbound flow

    outbound

    Set up an outbound flow

  • mandate_dataobjectonly when confirm=true

    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.

    • mandate_data.customer_acceptanceobjectRequired

      This hash contains details about the customer acceptance of the Mandate.

      • mandate_data.customer_acceptance.typestringRequired

        The type of customer acceptance information included with the Mandate. One of online or offline.

      • mandate_data.customer_acceptance.accepted_attimestampsecret key only

        The time at which the customer accepted the Mandate.

      • mandate_data.customer_acceptance.offlineobject

        If this is a Mandate accepted offline, this hash contains details about the offline acceptance.

      • mandate_data.customer_acceptance.onlineobject

        If this is a Mandate accepted online, this hash contains details about the online acceptance.

        • mandate_data.customer_acceptance.online.ip_addressstringRequired

          The IP address from which the Mandate was accepted by the customer.

        • mandate_data.customer_acceptance.online.user_agentstringRequired

          The user agent of the browser from which the Mandate was accepted by the customer.

  • on_behalf_ofstringConnect only

    The Stripe account ID created for this SetupIntent.

  • payment_method_configurationstring

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

  • payment_method_dataobject

    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.

    • 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.

      • 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.

      • 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.

      • 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.billieobject

      If this is a billie PaymentMethod, this hash contains details about the Billie 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.

      • payment_method_data.billing_details.addressobject

        Billing address.

        • 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.billing_details.tax_idstring

        Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

    • 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.

      • 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.cryptoobject

      If this is a Crypto PaymentMethod, this hash contains details about the Crypto 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.

      • 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.

      • 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.

      • 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.

      • payment_method_data.klarna.dobobject

        Customer’s date of birth

        • 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.

      • 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_accountobject

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

      • 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.

      • payment_method_data.p24.bankenum

        The customer’s bank.

    • payment_method_data.pay_by_bankobject

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

    • 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.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.

      • 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.satispayobject

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

    • payment_method_data.sepa_debitobject

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

      • 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.

      • 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.

      • 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 SetupIntent.

    • payment_method_options.acss_debitobject

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

      • payment_method_options.acss_debit.currencyenum

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

        Possible enum values
        cad

        Canadian dollars

        usd

        US dollars

      • payment_method_options.acss_debit.mandate_optionsobject

        Additional fields for Mandate creation

        • 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.default_forarray of enums

          List of Stripe products where this mandate can be selected automatically.

          Possible enum values
          invoice

          Enables payments for Stripe Invoices. ‘subscription’ must also be provided.

          subscription

          Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided.

        • 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.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.amazon_payobject

      If this is a amazon_pay SetupIntent, this sub-hash contains details about the AmazonPay payment method options.

    • payment_method_options.bacs_debitobject

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

      • payment_method_options.bacs_debit.mandate_optionsobject

        Additional fields for Mandate creation

        • 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.cardobject

      Configuration for any card setup attempted on this SetupIntent.

      • payment_method_options.card.mandate_optionsobject

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

        • 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.currencyenumRequired

          Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • 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 SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.

      • 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.three_d_secureobject

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

        • 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.cryptogramstringRequired for import 3ds

          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.electronic_commerce_indicatorenumRequired for import 3ds 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.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

          • payment_method_options.card.three_d_secure.network_options.cartes_bancairesobject

            Cartes Bancaires-specific 3DS fields.

            • 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.three_d_secure.transaction_idstringRequired for import 3ds

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

        • payment_method_options.card.three_d_secure.versionenumRequired for import 3ds

          The version of 3D Secure that was performed.

    • payment_method_options.card_presentobject

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

    • payment_method_options.klarnaobject

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

      • payment_method_options.klarna.currencyenum

        The currency of the SetupIntent. Three letter ISO currency code.

      • payment_method_options.klarna.on_demandobject

        On-demand details if setting up a payment method for on-demand payments.

        • payment_method_options.klarna.on_demand.average_amountinteger

          Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.

        • payment_method_options.klarna.on_demand.maximum_amountinteger

          The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.

        • payment_method_options.klarna.on_demand.minimum_amountinteger

          The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.

        • payment_method_options.klarna.on_demand.purchase_intervalenum

          Interval at which the customer is making purchases

          Possible enum values
          day

          Use day if you expect one or more days between charges.

          month

          Use month if you expect one or more months between charges.

          week

          Use week if you expect one or more weeks between charges.

          year

          Use year if you expect one or more years between charges.

        • payment_method_options.klarna.on_demand.purchase_interval_countinteger

          The number of purchase_interval between charges

      • 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.subscriptionsarray of objects

        Subscription details if setting up or charging a subscription

        • payment_method_options.klarna.subscriptions.intervalenumRequired

          Unit of time between subscription charges.

        • payment_method_options.klarna.subscriptions.next_billingobjectRequired

          Describes the upcoming charge for this subscription.

          • payment_method_options.klarna.subscriptions.next_billing.amountintegerRequired

            The amount of the next charge for the subscription.

          • payment_method_options.klarna.subscriptions.next_billing.datestringRequired

            The date of the next charge for the subscription in YYYY-MM-DD format.

        • payment_method_options.klarna.subscriptions.referencestringRequired

          A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.

        • payment_method_options.klarna.subscriptions.interval_countinteger

          The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.

        • payment_method_options.klarna.subscriptions.namestring

          Name for subscription.

    • payment_method_options.linkobject

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

    • payment_method_options.paypalobject

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

      • payment_method_options.paypal.billing_agreement_idstring

        The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.

    • payment_method_options.sepa_debitobject

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

      • payment_method_options.sepa_debit.mandate_optionsobject

        Additional fields for Mandate creation

        • 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.us_bank_accountobject

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

      • payment_method_options.us_bank_account.financial_connectionsobject

        Additional fields for Financial Connections Session creation

        • payment_method_options.us_bank_account.financial_connections.filtersobject

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

          • 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

        • 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

        • 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.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_typesarray of strings

    The list of payment method types (for example, card) that this SetupIntent can use. If you don’t provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.

  • return_urlstringonly when confirm=true

    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.

  • single_useobject

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    • single_use.amountintegerRequired

      Amount the customer is granting permission to collect later. 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).

    • single_use.currencyenumRequired

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

  • use_stripe_sdkboolean

    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

Returns

Returns a SetupIntent object.

POST /v1/setup_intents
const stripe = require('stripe')('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
const setupIntent = await stripe.setupIntents.create({
  payment_method_types: ['card'],
});
Response
{
  "id": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG",
  "object": "setup_intent",
  "application": null,
  "cancellation_reason": null,
  "client_secret": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG_secret_NXDICkPqPeiBTAFqWmkbff09lRmSVXe",
  "created": 1678942624,
  "customer": null,
  "description": null,
  "flow_directions": null,
  "last_setup_error": null,
  "latest_attempt": null,
  "livemode": false,
  "mandate": null,
  "metadata": {},
  "next_action": null,
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_options": {
    "card": {
      "mandate_options": null,
      "network": null,
      "request_three_d_secure": "automatic"
    }
  },
  "payment_method_types": [
    "card"
  ],
  "single_use_mandate": null,
  "status": "requires_payment_method",
  "usage": "off_session"
}