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.

Returns

Returns a SetupIntent object.

Parameters

attach_to_self (boolean, optional) 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.
automatic_payment_methods (object, optional) 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.enabled (boolean, required) Whether this feature is enabled.
- automatic_payment_methods.allow_redirects (enum, optional) 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.
confirm (boolean, optional) 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.
confirmation_token (string, optional) 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.
customer (string, optional) 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.
customer_account (string, optional) ID of the Account this SetupIntent belongs to, if one exists.
If present, the SetupIntent’s payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
description (string, optional) An arbitrary string attached to the object. Often useful for displaying to users.
excluded_payment_method_types (array of enums, optional) The list of payment method types to exclude from use with this SetupIntent. Possible enum values:
- acss_debit Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).
- affirm Affirm is a buy now, pay later payment method in the US.
- afterpay_clearpay Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.
- alipay Alipay is a digital wallet payment method used in China.
- alma Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.
- amazon_pay Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.
- au_becs_debit BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).
- bacs_debit Bacs Direct Debit is used to debit UK bank accounts.
- bancontact Bancontact is a bank redirect payment method used in Belgium.
- billie Billie is a payment method.
- blik BLIK is a single-use payment method common in Poland.
- boleto Boleto is a voucher-based payment method used in Brazil.
- card Card payments are supported through many networks, card brands, and select Link funding sources.
- card_present Stripe Terminal is used to collect in-person card payments.
- cashapp Cash App Pay enables customers to frictionlessly authenticate payments in the Cash App using their stored balance or linked card.
- crypto Stablecoin payments enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask.
- customer_balance Uses a customer’s cash balance for the payment.
- eps EPS is an Austria-based bank redirect payment method.
- fpx FPX is a Malaysia-based bank redirect payment method.
- giropay giropay is a German bank redirect payment method.
- grabpay GrabPay is a digital wallet payment method used in Southeast Asia.
- ideal iDEAL is a Netherlands-based bank redirect payment method.
- interac_present Stripe Terminal accepts Interac debit cards for in-person payments in Canada.
- kakao_pay Kakao Pay is a digital wallet payment method used in South Korea.
- klarna Klarna is a global buy now, pay later payment method.
- konbini Konbini is a cash-based voucher payment method used in Japan.
- kr_card Korean cards enables customers to accept local credit and debit cards in South Korea.
- mb_way MB WAY is a payment method.
- mobilepay MobilePay is a Nordic card-passthrough wallet payment method where customers authorize the payment in the MobilePay application.
- multibanco Multibanco is a voucher payment method
- naver_pay Naver Pay is a digital wallet payment method used in South Korea.
- nz_bank_account New Zealand BECS Direct Debit is used to debit New Zealand bank accounts through the Bulk Electronic Clearing System (BECS).
- oxxo OXXO is a cash-based voucher payment method used in Mexico.
- p24 Przelewy24 is a bank redirect payment method used in Poland.
- pay_by_bank Pay By Bank is an open banking payment method in the UK.
- payco PAYCO is a digital wallet payment method used in South Korea.
- paynow PayNow is a QR code payment method used in Singapore.
- paypal PayPal is an online wallet and redirect payment method commonly used in Europe.
- paypay PayPay is a payment method.
- payto PayTo is a real time payment method
- pix Pix is an instant bank transfer payment method in Brazil.
- promptpay PromptPay is an instant funds transfer service popular in Thailand.
- revolut_pay Revolut Pay is a digital wallet payment method used in the United Kingdom.
- samsung_pay Samsung Pay is a digital wallet payment method used in South Korea.
- satispay Satispay is a payment method.
- sepa_debit SEPA Direct Debit is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.
- sofort Sofort is a bank redirect payment method used in Europe.
- sunbit Sunbit is a payment method.
- swish Swish is a Swedish wallet payment method where customers authorize the payment in the Swish application.
- twint TWINT is a single-use payment method used in Switzerland.
- upi UPI is an instant real-time payment system in India.
- us_bank_account ACH Direct Debit is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.
- wechat_pay WeChat Pay is a digital wallet payment method based in China.
- zip Zip is a Buy now, pay later Payment Method
flow_directions (array of enums, optional) 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_data (object, optional) This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
- mandate_data.customer_acceptance (object, required) This hash contains details about the customer acceptance of the Mandate.
  - mandate_data.customer_acceptance.type (string, required) The type of customer acceptance information included with the Mandate. One of online or offline.
  - mandate_data.customer_acceptance.accepted_at (timestamp, optional) The time at which the customer accepted the Mandate.
  - mandate_data.customer_acceptance.offline (object, optional) If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
  - mandate_data.customer_acceptance.online (object, optional) If this is a Mandate accepted online, this hash contains details about the online acceptance.
    - mandate_data.customer_acceptance.online.ip_address (string, required) The IP address from which the Mandate was accepted by the customer.
    - mandate_data.customer_acceptance.online.user_agent (string, required) The user agent of the browser from which the Mandate was accepted by the customer.
metadata (object, optional) 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.
on_behalf_of (string, optional) The Stripe account ID created for this SetupIntent.
payment_method (string, optional) ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
payment_method_configuration (string, optional) The ID of the payment method configuration to use with this SetupIntent.
The maximum length is 100 characters.
payment_method_data (object, optional) When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
- payment_method_data.type (enum, required) 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_debit (object, optional) If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
  - payment_method_data.acss_debit.account_number (string, required) Customer’s bank account number.
  - payment_method_data.acss_debit.institution_number (string, required) Institution number of the customer’s bank.
  - payment_method_data.acss_debit.transit_number (string, required) Transit number of the customer’s bank.
- payment_method_data.affirm (object, optional) If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.
- payment_method_data.afterpay_clearpay (object, optional) If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
- payment_method_data.alipay (object, optional) If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.
- payment_method_data.allow_redisplay (enum, optional) 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.alma (object, optional) If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
- payment_method_data.amazon_pay (object, optional) If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
- payment_method_data.au_becs_debit (object, optional) If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
  - payment_method_data.au_becs_debit.account_number (string, required) The account number for the bank account.
  - payment_method_data.au_becs_debit.bsb_number (string, required) Bank-State-Branch number of the bank account.
- payment_method_data.bacs_debit (object, optional) If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
  - payment_method_data.bacs_debit.account_number (string, optional) Account number of the bank account that the funds will be debited from.
  - payment_method_data.bacs_debit.sort_code (string, optional) Sort code of the bank account. (e.g., 10-20-30)
- payment_method_data.bancontact (object, optional) If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.
- payment_method_data.billie (object, optional) If this is a billie PaymentMethod, this hash contains details about the Billie payment method.
- payment_method_data.billing_details (object, optional) Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
  - payment_method_data.billing_details.address (object, optional) Billing address.
    - payment_method_data.billing_details.address.city (string, optional) City, district, suburb, town, or village.
    - payment_method_data.billing_details.address.country (string, optional) Two-letter country code (ISO 3166-1 alpha-2).
    - payment_method_data.billing_details.address.line1 (string, optional) Address line 1, such as the street, PO Box, or company name.
    - payment_method_data.billing_details.address.line2 (string, optional) Address line 2, such as the apartment, suite, unit, or building.
    - payment_method_data.billing_details.address.postal_code (string, optional) ZIP or postal code.
    - payment_method_data.billing_details.address.state (string, optional) State, county, province, or region (ISO 3166-2).
  - payment_method_data.billing_details.email (string, optional) Email address.
    The maximum length is 800 characters.
  - payment_method_data.billing_details.name (string, optional) Full name.
  - payment_method_data.billing_details.phone (string, optional) Billing phone number (including extension).
  - payment_method_data.billing_details.tax_id (string, optional) Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
- payment_method_data.blik (object, optional) If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.
- payment_method_data.boleto (object, optional) If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
  - payment_method_data.boleto.tax_id (string, required) The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
- payment_method_data.cashapp (object, optional) If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.
- payment_method_data.crypto (object, optional) If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
- payment_method_data.customer_balance (object, optional) If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.
- payment_method_data.eps (object, optional) If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
  - payment_method_data.eps.bank (string, optional) The customer’s bank.
- payment_method_data.fpx (object, optional) If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
  - payment_method_data.fpx.bank (string, required) The customer’s bank.
- payment_method_data.giropay (object, optional) If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.
- payment_method_data.grabpay (object, optional) If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.
- payment_method_data.ideal (object, optional) If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
  - payment_method_data.ideal.bank (string, optional) The customer’s bank. Only use this parameter for existing customers. Don’t use it for new customers.
- payment_method_data.interac_present (object, optional) If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.
- payment_method_data.kakao_pay (object, optional) If this is a kakao_pay PaymentMethod, this hash contains details about the Kakao Pay payment method.
- payment_method_data.klarna (object, optional) If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
  - payment_method_data.klarna.dob (object, optional) Customer’s date of birth
    - payment_method_data.klarna.dob.day (integer, required) The day of birth, between 1 and 31.
    - payment_method_data.klarna.dob.month (integer, required) The month of birth, between 1 and 12.
    - payment_method_data.klarna.dob.year (integer, required) The four-digit year of birth.
- payment_method_data.konbini (object, optional) If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.
- payment_method_data.kr_card (object, optional) If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.
- payment_method_data.link (object, optional) If this is an Link PaymentMethod, this hash contains details about the Link payment method.
- payment_method_data.mb_way (object, optional) If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
- payment_method_data.metadata (object, optional) 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.mobilepay (object, optional) If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.
- payment_method_data.multibanco (object, optional) If this is a multibanco PaymentMethod, this hash contains details about the Multibanco payment method.
- payment_method_data.naver_pay (object, optional) If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
  - payment_method_data.naver_pay.funding (enum, optional) 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_account (object, optional) 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_number (string, required) The account number for the bank account.
  - payment_method_data.nz_bank_account.bank_code (string, required) The numeric code for the bank account’s bank.
  - payment_method_data.nz_bank_account.branch_code (string, required) The numeric code for the bank account’s bank branch.
  - payment_method_data.nz_bank_account.suffix (string, required) The suffix of the bank account number.
  - payment_method_data.nz_bank_account.account_holder_name (string, optional) 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.oxxo (object, optional) If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.
- payment_method_data.p24 (object, optional) If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
  - payment_method_data.p24.bank (enum, optional) The customer’s bank.
- payment_method_data.pay_by_bank (object, optional) If this is a pay_by_bank PaymentMethod, this hash contains details about the PayByBank payment method.
- payment_method_data.payco (object, optional) If this is a payco PaymentMethod, this hash contains details about the PAYCO payment method.
- payment_method_data.paynow (object, optional) If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.
- payment_method_data.paypal (object, optional) If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.
- payment_method_data.paypay (object, optional) If this is a paypay PaymentMethod, this hash contains details about the PayPay payment method.
- payment_method_data.payto (object, optional) If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
  - payment_method_data.payto.account_number (string, optional) The account number for the bank account.
  - payment_method_data.payto.bsb_number (string, optional) Bank-State-Branch number of the bank account.
  - payment_method_data.payto.pay_id (string, optional) The PayID alias for the bank account.
- payment_method_data.pix (object, optional) If this is a pix PaymentMethod, this hash contains details about the Pix payment method.
- payment_method_data.promptpay (object, optional) If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.
- payment_method_data.radar_options (object, optional) Options to configure Radar. See Radar Session for more information.
  - payment_method_data.radar_options.session (string, optional) 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_pay (object, optional) If this is a revolut_pay PaymentMethod, this hash contains details about the Revolut Pay payment method.
- payment_method_data.samsung_pay (object, optional) If this is a samsung_pay PaymentMethod, this hash contains details about the SamsungPay payment method.
- payment_method_data.satispay (object, optional) If this is a satispay PaymentMethod, this hash contains details about the Satispay payment method.
- payment_method_data.sepa_debit (object, optional) If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
  - payment_method_data.sepa_debit.iban (string, required) IBAN of the bank account.
- payment_method_data.sofort (object, optional) If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
  - payment_method_data.sofort.country (enum, required) 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.sunbit (object, optional) If this is a Sunbit PaymentMethod, this hash contains details about the Sunbit payment method.
- payment_method_data.swish (object, optional) If this is a swish PaymentMethod, this hash contains details about the Swish payment method.
- payment_method_data.twint (object, optional) If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
- payment_method_data.upi (object, optional) If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
  - payment_method_data.upi.mandate_options (object, optional) Configuration options for setting up an eMandate
    - payment_method_data.upi.mandate_options.amount (integer, optional) Amount to be charged for future payments.
    - payment_method_data.upi.mandate_options.amount_type (enum, optional) 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 If fixed, the amount param refers to the exact amount to be charged in future payments.
      - maximum If maximum, the amount charged can be up to the value passed for the amount param.
    - payment_method_data.upi.mandate_options.description (string, optional) A description of the mandate or subscription that is meant to be displayed to the customer.
      The maximum length is 20 characters.
    - payment_method_data.upi.mandate_options.end_date (timestamp, optional) End date of the mandate or subscription.
- payment_method_data.us_bank_account (object, optional) 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_type (enum, optional) 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_number (string, optional) Account number of the bank account.
  - payment_method_data.us_bank_account.account_type (enum, optional) 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_account (string, optional) The ID of a Financial Connections Account to use as a payment method.
  - payment_method_data.us_bank_account.routing_number (string, optional) Routing number of the bank account.
- payment_method_data.wechat_pay (object, optional) If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.
- payment_method_data.zip (object, optional) If this is a zip PaymentMethod, this hash contains details about the Zip payment method.
payment_method_options (object, optional) Payment method-specific configuration for this SetupIntent.
- payment_method_options.acss_debit (object, optional) If this is a acss_debit SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
  - payment_method_options.acss_debit.currency (enum, optional) 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_options (object, optional) Additional fields for Mandate creation
    - payment_method_options.acss_debit.mandate_options.custom_mandate_url (string, optional) 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_for (array of enums, optional) 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_description (string, optional) Description of the mandate interval. Only required if ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.
      The maximum length is 500 characters.
    - payment_method_options.acss_debit.mandate_options.payment_schedule (enum, optional) 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_type (enum, optional) 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_method (enum, optional) Bank account verification method. The default value is automatic. Possible enum values:
    - automatic Instant verification with fallback to microdeposits.
    - instant Instant verification.
    - microdeposits Verification using microdeposits.
- payment_method_options.amazon_pay (object, optional) If this is a amazon_pay SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
- payment_method_options.bacs_debit (object, optional) 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_options (object, optional) Additional fields for Mandate creation
    - payment_method_options.bacs_debit.mandate_options.reference_prefix (string, optional) 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’.
      The maximum length is 12 characters.
- payment_method_options.card (object, optional) Configuration for any card setup attempted on this SetupIntent.
  - payment_method_options.card.mandate_options (object, optional) Configuration options for setting up an eMandate for cards issued in India.
    - payment_method_options.card.mandate_options.amount (integer, required) Amount to be charged for future payments, specified in the presentment currency.
    - payment_method_options.card.mandate_options.amount_type (enum, required) 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.currency (enum, required) 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.interval (enum, required) 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.reference (string, required) Unique identifier for the mandate or subscription.
      The maximum length is 80 characters.
    - payment_method_options.card.mandate_options.start_date (timestamp, required) Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    - payment_method_options.card.mandate_options.description (string, optional) A description of the mandate or subscription that is meant to be displayed to the customer.
      The maximum length is 200 characters.
    - payment_method_options.card.mandate_options.end_date (timestamp, optional) 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_count (integer, optional) 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_types (array of enums, optional) Specifies the type of mandates supported. Possible values are india. Possible enum values:
      - india
  - payment_method_options.card.network (string, optional) 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_secure (enum, optional) 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_secure (object, optional) 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_status (enum, optional) 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.cryptogram (string, Required 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_indicator (enum, Required 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:
      - 01Mastercard variant: Attempt acknowledged.
      - 02Mastercard 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.
      - 07Mastercard variant: Fully authenticated recurring transaction.
    - payment_method_options.card.three_d_secure.network_options (object, optional) 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_bancaires (object, optional) Cartes Bancaires-specific 3DS fields.
        payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo (enum, required) 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_exemption (string, optional) 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
        The maximum length is 4 characters.
        payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score (integer, optional) 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_indicator (string, optional) 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.
      The maximum length is 2 characters.
    - payment_method_options.card.three_d_secure.transaction_id (string, Required 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.version (enum, Required for Import 3DS) The version of 3D Secure that was performed.
- payment_method_options.card_present (object, optional) If this is a card_present PaymentMethod, this sub-hash contains details about the card-present payment method options.
- payment_method_options.klarna (object, optional) If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method options.
  - payment_method_options.klarna.currency (enum, optional) The currency of the SetupIntent. Three letter ISO currency code.
  - payment_method_options.klarna.on_demand (object, optional) On-demand details if setting up a payment method for on-demand payments.
    - payment_method_options.klarna.on_demand.average_amount (integer, optional) 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_amount (integer, optional) 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_amount (integer, optional) 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_interval (enum, optional) 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_count (integer, optional) The number of purchase_interval between charges
  - payment_method_options.klarna.preferred_locale (enum, optional) 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
    - en-CH English - Switzerland
    - en-CZ English - Czechia
    - en-DE English - Germany
    - en-DK English - Denmark
    - en-ES English - Spain
    - en-FI English - Finland
    - en-FR English - France
    - en-GB English - United Kingdom
    - en-GR English - Greece
    - en-IE English - Ireland
    - en-IT English - Italy
    - en-NL English - Netherlands
    - en-NO English - Norway
    - en-NZ English - New Zealand
    - en-PL English - Poland
    - en-PT English - Portugal
    - en-RO English - Romania
    - en-SE English - Sweden
    - en-US English - United States of America
    - es-ES Spanish - Spain
    - es-US Spanish - United States of America
    - fi-FI Finnish - Finland
    - fr-BE French - Belgium
    - fr-CA French - Canada
    - fr-CH French - Switzerland
    - fr-FR French - France
    - it-CH Italy - Switzerland
    - it-IT Italian - Italy
    - nb-NO Norwegian - Norway
    - nl-BE Dutch - Belgium
    - nl-NL Dutch - Netherlands
    - pl-PL Polish - Poland
    - pt-PT Portugese - Portugal
    - ro-RO Romanian - Romania
    - sv-FI Swedish - Finland
    - sv-SE Swedish - Sweden
  - payment_method_options.klarna.subscriptions (array of objects, optional) Subscription details if setting up or charging a subscription
    - payment_method_options.klarna.subscriptions.interval (enum, required) Unit of time between subscription charges.
    - payment_method_options.klarna.subscriptions.next_billing (object, required) Describes the upcoming charge for this subscription.
      - payment_method_options.klarna.subscriptions.next_billing.amount (integer, required) The amount of the next charge for the subscription.
      - payment_method_options.klarna.subscriptions.next_billing.date (string, required) The date of the next charge for the subscription in YYYY-MM-DD format.
    - payment_method_options.klarna.subscriptions.reference (string, required) A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
      The maximum length is 255 characters.
    - payment_method_options.klarna.subscriptions.interval_count (integer, optional) 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.name (string, optional) Name for subscription.
      The maximum length is 255 characters.
- payment_method_options.link (object, optional) If this is a link PaymentMethod, this sub-hash contains details about the Link payment method options.
- payment_method_options.paypal (object, optional) If this is a paypal PaymentMethod, this sub-hash contains details about the PayPal payment method options.
  - payment_method_options.paypal.billing_agreement_id (string, optional) 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.payto (object, optional) If this is a payto SetupIntent, this sub-hash contains details about the PayTo payment method options.
  - payment_method_options.payto.mandate_options (object, optional) Additional fields for Mandate creation.
    - payment_method_options.payto.mandate_options.amount (integer, optional) Amount that will be collected. It is required when amount_type is fixed.
    - payment_method_options.payto.mandate_options.amount_type (enum, optional) The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum. Possible enum values:
      - fixed The amount is the exact amount that will be charged.
      - maximum The amount is the maximum amount that can be charged.
    - payment_method_options.payto.mandate_options.end_date (string, optional) Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    - payment_method_options.payto.mandate_options.payment_schedule (enum, optional) The periodicity at which payments will be collected. Defaults to adhoc. Possible enum values:
      - adhoc Payments will be made ad hoc
      - annual Payments will be made annually
      - daily Payments will be made daily
      - fortnightly Payments will be made fortnightly
      - monthly Payments will be made monthly
      - quarterly Payments will be made quarterly
      - semi_annual Payments will be made semi-annually
      - weekly Payments will be made weekly
    - payment_method_options.payto.mandate_options.payments_per_period (integer, optional) The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.
    - payment_method_options.payto.mandate_options.purpose (enum, optional) The purpose for which payments are made. Has a default value based on your merchant category code. Possible enum values:
      - dependant_support Transactions are made for dependant support reasons
      - government Transactions are made for government reasons
      - loan Transactions are made for loan reasons
      - mortgage Transactions are made for mortgage reasons
      - other Transactions are made for other reasons
      - pension Transactions are made for pension reasons
      - personal Transactions are made for personal reasons
      - retail Transactions are made for retail reasons
      - salary Transactions are made for salary reasons
      - tax Transactions are made for tax reasons
      - utility Transactions are made for utility reasons
    - payment_method_options.payto.mandate_options.start_date (string, optional) Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
- payment_method_options.pix (object, optional) If this is a pix SetupIntent, this sub-hash contains details about the Pix payment method options.
  - payment_method_options.pix.mandate_options (object, optional) Additional fields for mandate creation.
    - payment_method_options.pix.mandate_options.amount (integer, optional) Amount to be charged for future payments. Required when amount_type=fixed. If not provided for amount_type=maximum, defaults to 40000.
    - payment_method_options.pix.mandate_options.amount_includes_iof (enum, optional) Determines if the amount includes the IOF tax. Defaults to never. Possible enum values:
      - always The IOF tax is included in the amount.
      - never The IOF tax is not included in the amount.
    - payment_method_options.pix.mandate_options.amount_type (enum, optional) Type of amount. Defaults to maximum. Possible enum values:
      - fixed The exact amount for future payments.
      - maximum The maximum amount for future payments.
    - payment_method_options.pix.mandate_options.currency (enum, optional) Three-letter ISO currency code, in lowercase. Only brl is supported currently.
    - payment_method_options.pix.mandate_options.end_date (string, optional) Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
    - payment_method_options.pix.mandate_options.payment_schedule (enum, optional) Schedule at which the future payments will be charged. Defaults to monthly. Possible enum values:
      - halfyearly The future payments will be charged half-yearly.
      - monthly The future payments will be charged monthly.
      - quarterly The future payments will be charged quarterly.
      - weekly The future payments will be charged weekly.
      - yearly The future payments will be charged yearly.
    - payment_method_options.pix.mandate_options.reference (string, optional) Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
      The maximum length is 35 characters.
    - payment_method_options.pix.mandate_options.start_date (string, optional) Start date of the mandate, in YYYY-MM-DD. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
- payment_method_options.sepa_debit (object, optional) 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_options (object, optional) Additional fields for Mandate creation
    - payment_method_options.sepa_debit.mandate_options.reference_prefix (string, optional) 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’.
      The maximum length is 12 characters.
- payment_method_options.upi (object, optional) If this is a upi SetupIntent, this sub-hash contains details about the UPI payment method options.
  - payment_method_options.upi.mandate_options (object, optional) Configuration options for setting up an eMandate
    - payment_method_options.upi.mandate_options.amount (integer, optional) Amount to be charged for future payments.
    - payment_method_options.upi.mandate_options.amount_type (enum, optional) 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 If fixed, the amount param refers to the exact amount to be charged in future payments.
      - maximum If maximum, the amount charged can be up to the value passed for the amount param.
    - payment_method_options.upi.mandate_options.description (string, optional) A description of the mandate or subscription that is meant to be displayed to the customer.
      The maximum length is 20 characters.
    - payment_method_options.upi.mandate_options.end_date (timestamp, optional) End date of the mandate or subscription.
- payment_method_options.us_bank_account (object, optional) 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_connections (object, optional) Additional fields for Financial Connections Session creation
    - payment_method_options.us_bank_account.financial_connections.filters (object, optional) 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_subcategories (array of strings, optional) The account subcategories to use to filter for selectable accounts. Valid subcategories are checking and savings.
    - payment_method_options.us_bank_account.financial_connections.permissions (array of strings, optional) 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.prefetch (array of enums, optional) 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_url (string, optional) 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_options (object, optional) Additional fields for Mandate creation
    - payment_method_options.us_bank_account.mandate_options.collection_method (enum, optional) 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.networks (object, optional) Additional fields for network related functions
    - payment_method_options.us_bank_account.networks.requested (array of enums, optional) Triggers validations to run across the selected networks Possible enum values:
      - ach
      - us_domestic_wire
  - payment_method_options.us_bank_account.verification_method (enum, optional) Bank account verification method. The default value is automatic. 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_types (array of strings, optional) 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_url (string, optional) 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_use (object, optional) 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.amount (integer, required) 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.currency (enum, required) Three-letter ISO currency code, in lowercase. Must be a supported currency.
usage (enum, optional) 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.
use_stripe_sdk (boolean, optional) Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

curl

curl https://api.stripe.com/v1/setup_intents \
  -u "<<YOUR_SECRET_KEY>>" \
  -d "payment_method_types[]=card"

Response

json

{
  "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"
}

Create a SetupIntent ​

Returns ​

Parameters ​

Response ​

Create a SetupIntent

Returns

Parameters

Response