POST /v1/setup_intents/{intent}

Updates a SetupIntent object.

Servers

Path parameters

Name Type Required Description
intent String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
customer String No

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.

payment_method_data Object No

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

payment_method_data.swish Object No
payment_method_data.metadata Object No
payment_method_data.multibanco Object No
payment_method_data.affirm Object No
payment_method_data.mobilepay Object No
payment_method_data.paynow Object No
payment_method_data.billing_details Object No
payment_method_data.billing_details.email No
payment_method_data.billing_details.name No
payment_method_data.billing_details.tax_id String No
payment_method_data.billing_details.phone No
payment_method_data.billing_details.address No
payment_method_data.customer_balance Object No
payment_method_data.pix Object No
payment_method_data.sofort Object No
payment_method_data.sofort.country String Yes

Possible values:

  • "ES"
  • "NL"
  • "IT"
  • "AT"
  • "BE"
  • "DE"
payment_method_data.alipay Object No
payment_method_data.interac_present Object No
payment_method_data.cashapp Object No
payment_method_data.zip Object No
payment_method_data.type String Yes

Possible values:

  • "p24"
  • "pay_by_bank"
  • "blik"
  • "crypto"
  • "amazon_pay"
  • "boleto"
  • "bacs_debit"
  • "giropay"
  • "eps"
  • "paynow"
  • "pix"
  • "fpx"
  • "promptpay"
  • "zip"
  • "alipay"
  • "naver_pay"
  • "revolut_pay"
  • "billie"
  • "klarna"
  • "bancontact"
  • "kr_card"
  • "swish"
  • "paypal"
  • "samsung_pay"
  • "sofort"
  • "nz_bank_account"
  • "au_becs_debit"
  • "kakao_pay"
  • "konbini"
  • "acss_debit"
  • "link"
  • "alma"
  • "satispay"
  • "payco"
  • "sepa_debit"
  • "us_bank_account"
  • "oxxo"
  • "cashapp"
  • "affirm"
  • "twint"
  • "afterpay_clearpay"
  • "customer_balance"
  • "grabpay"
  • "multibanco"
  • "ideal"
  • "wechat_pay"
  • "mobilepay"
payment_method_data.afterpay_clearpay Object No
payment_method_data.twint Object No
payment_method_data.eps Object No
payment_method_data.eps.bank String No

Possible values:

  • "vr_bank_braunau"
  • "hypo_bank_burgenland_aktiengesellschaft"
  • "bank_austria"
  • "austrian_anadi_bank_ag"
  • "volkskreditbank_ag"
  • "bankhaus_carl_spangler"
  • "bawag_psk_ag"
  • "bankhaus_schelhammer_und_schattera_ag"
  • "capital_bank_grawe_gruppe_ag"
  • "raiffeisen_bankengruppe_osterreich"
  • "btv_vier_lander_bank"
  • "dolomitenbank"
  • "erste_bank_und_sparkassen"
  • "hypo_alpeadriabank_international_ag"
  • "schoellerbank_ag"
  • "marchfelder_bank"
  • "volksbank_gruppe"
  • "hypo_vorarlberg_bank_ag"
  • "bks_bank_ag"
  • "hypo_oberosterreich_salzburg_steiermark"
  • "easybank_ag"
  • "deutsche_bank_ag"
  • "sparda_bank_wien"
  • "hypo_tirol_bank_ag"
  • "arzte_und_apotheker_bank"
  • "brull_kallmus_bank_ag"
  • "oberbank_ag"
  • "hypo_noe_lb_fur_niederosterreich_u_wien"
payment_method_data.us_bank_account Object No
payment_method_data.us_bank_account.routing_number String No
payment_method_data.us_bank_account.account_number String No
payment_method_data.us_bank_account.financial_connections_account String No
payment_method_data.us_bank_account.account_holder_type String No

Possible values:

  • "company"
  • "individual"
payment_method_data.us_bank_account.account_type String No

Possible values:

  • "checking"
  • "savings"
payment_method_data.au_becs_debit Object No
payment_method_data.au_becs_debit.account_number String Yes
payment_method_data.au_becs_debit.bsb_number String Yes
payment_method_data.konbini Object No
payment_method_data.oxxo Object No
payment_method_data.bancontact Object No
payment_method_data.p24 Object No
payment_method_data.p24.bank String No

Possible values:

  • "banki_spbdzielcze"
  • "credit_agricole"
  • "bank_millennium"
  • "inteligo"
  • "plus_bank"
  • "bank_nowy_bfg_sa"
  • "citi_handlowy"
  • "blik"
  • "getin_bank"
  • "velobank"
  • "bank_pekao_sa"
  • "boz"
  • "ideabank"
  • "volkswagen_bank"
  • "alior_bank"
  • "bnp_paribas"
  • "tmobile_usbugi_bankowe"
  • "toyota_bank"
  • "mbank_mtransfer"
  • "santander_przelew24"
  • "etransfer_pocztowy24"
  • "envelobank"
  • "nest_przelew"
  • "ing"
  • "noble_pay"
  • "pbac_z_ipko"
payment_method_data.allow_redisplay String No

Possible values:

  • "limited"
  • "unspecified"
  • "always"
payment_method_data.radar_options Object No
payment_method_data.radar_options.session String No
payment_method_data.ideal Object No
payment_method_data.ideal.bank String No

Possible values:

  • "knab"
  • "n26"
  • "rabobank"
  • "sns_bank"
  • "triodos_bank"
  • "bunq"
  • "buut"
  • "van_lanschot"
  • "nn"
  • "ing"
  • "abn_amro"
  • "asn_bank"
  • "handelsbanken"
  • "revolut"
  • "moneyou"
  • "regiobank"
  • "yoursafe"
payment_method_data.amazon_pay Object No
payment_method_data.paypal Object No
payment_method_data.bacs_debit Object No
payment_method_data.bacs_debit.sort_code String No
payment_method_data.bacs_debit.account_number String No
payment_method_data.naver_pay Object No
payment_method_data.naver_pay.funding String No

Possible values:

  • "card"
  • "points"
payment_method_data.klarna Object No
payment_method_data.klarna.dob Object No
payment_method_data.klarna.dob.day Integer Yes
payment_method_data.klarna.dob.month Integer Yes
payment_method_data.klarna.dob.year Integer Yes
payment_method_data.acss_debit Object No
payment_method_data.acss_debit.institution_number String Yes
payment_method_data.acss_debit.transit_number String Yes
payment_method_data.acss_debit.account_number String Yes
payment_method_data.blik Object No
payment_method_data.payco Object No
payment_method_data.wechat_pay Object No
payment_method_data.pay_by_bank Object No
payment_method_data.promptpay Object No
payment_method_data.giropay Object No
payment_method_data.kakao_pay Object No
payment_method_data.crypto Object No
payment_method_data.alma Object No
payment_method_data.link Object No
payment_method_data.satispay Object No
payment_method_data.fpx Object No
payment_method_data.fpx.bank String Yes

Possible values:

  • "bank_rakyat"
  • "hsbc"
  • "hong_leong_bank"
  • "ocbc"
  • "kfh"
  • "public_bank"
  • "alliance_bank"
  • "maybank2u"
  • "uob"
  • "agrobank"
  • "bsn"
  • "deutsche_bank"
  • "cimb"
  • "rhb"
  • "ambank"
  • "standard_chartered"
  • "affin_bank"
  • "bank_islam"
  • "pb_enterprise"
  • "maybank2e"
  • "bank_of_china"
  • "bank_muamalat"
payment_method_data.revolut_pay Object No
payment_method_data.billie Object No
payment_method_data.sepa_debit Object No
payment_method_data.sepa_debit.iban String Yes
payment_method_data.kr_card Object No
payment_method_data.samsung_pay Object No
payment_method_data.nz_bank_account Object No
payment_method_data.nz_bank_account.bank_code String Yes
payment_method_data.nz_bank_account.branch_code String Yes
payment_method_data.nz_bank_account.account_number String Yes
payment_method_data.nz_bank_account.account_holder_name String No
payment_method_data.nz_bank_account.reference String No
payment_method_data.nz_bank_account.suffix String Yes
payment_method_data.grabpay Object No
payment_method_data.boleto Object No
payment_method_data.boleto.tax_id String Yes
attach_to_self Boolean No

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.

description String No

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

payment_method_configuration String No

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

expand[] Array No

Specifies which fields in the response should be expanded.

metadata No

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.

flow_directions[] Array No

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.

payment_method String No

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

payment_method_types[] Array No

The list of payment method types (for example, card) that this SetupIntent can set up. 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.

payment_method_options Object No

Payment method-specific configuration for this SetupIntent.

payment_method_options.card_present Object No
payment_method_options.amazon_pay Object No
payment_method_options.paypal Object No
payment_method_options.paypal.billing_agreement_id String No
payment_method_options.bacs_debit Object No
payment_method_options.bacs_debit.mandate_options Object No
payment_method_options.bacs_debit.mandate_options.reference_prefix No
payment_method_options.card Object No
payment_method_options.card.network String No

Possible values:

  • "diners"
  • "unionpay"
  • "girocard"
  • "visa"
  • "jcb"
  • "cartes_bancaires"
  • "link"
  • "amex"
  • "discover"
  • "interac"
  • "eftpos_au"
  • "unknown"
  • "mastercard"
payment_method_options.card.mandate_options Object No
payment_method_options.card.mandate_options.description String No
payment_method_options.card.mandate_options.start_date Integer Yes
payment_method_options.card.mandate_options.amount_type String Yes

Possible values:

  • "fixed"
  • "maximum"
payment_method_options.card.mandate_options.end_date Integer No
payment_method_options.card.mandate_options.interval String Yes

Possible values:

  • "month"
  • "day"
  • "sporadic"
  • "week"
  • "year"
payment_method_options.card.mandate_options.amount Integer Yes
payment_method_options.card.mandate_options.reference String Yes
payment_method_options.card.mandate_options.supported_types[] Array No
payment_method_options.card.mandate_options.currency String Yes
payment_method_options.card.mandate_options.interval_count Integer No
payment_method_options.card.three_d_secure Object No
payment_method_options.card.three_d_secure.requestor_challenge_indicator String No
payment_method_options.card.three_d_secure.ares_trans_status String No

Possible values:

  • "C"
  • "R"
  • "A"
  • "N"
  • "I"
  • "Y"
  • "U"
payment_method_options.card.three_d_secure.electronic_commerce_indicator String No

Possible values:

  • "07"
  • "06"
  • "05"
  • "02"
  • "01"
payment_method_options.card.three_d_secure.version String No

Possible values:

  • "2.1.0"
  • "2.2.0"
  • "1.0.2"
payment_method_options.card.three_d_secure.cryptogram String No
payment_method_options.card.three_d_secure.network_options Object No
payment_method_options.card.three_d_secure.network_options.cartes_bancaires Object No
payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo String Yes

Possible values:

  • "4"
  • "3"
  • "2"
  • "1"
  • "A"
  • "0"
payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score Integer No
payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption String No
payment_method_options.card.three_d_secure.transaction_id String No
payment_method_options.card.request_three_d_secure String No

Possible values:

  • "any"
  • "challenge"
  • "automatic"
payment_method_options.klarna Object No
payment_method_options.klarna.on_demand Object No
payment_method_options.klarna.on_demand.maximum_amount Integer No
payment_method_options.klarna.on_demand.purchase_interval String No

Possible values:

  • "month"
  • "day"
  • "week"
  • "year"
payment_method_options.klarna.on_demand.average_amount Integer No
payment_method_options.klarna.on_demand.purchase_interval_count Integer No
payment_method_options.klarna.on_demand.minimum_amount Integer No
payment_method_options.klarna.preferred_locale String No

Possible values:

  • "fr-CH"
  • "nl-BE"
  • "en-FR"
  • "en-GR"
  • "en-IT"
  • "en-NZ"
  • "fr-FR"
  • "nb-NO"
  • "de-DE"
  • "en-CH"
  • "en-PT"
  • "pl-PL"
  • "es-US"
  • "en-CA"
  • "en-RO"
  • "sv-FI"
  • "en-US"
  • "en-IE"
  • "en-CZ"
  • "ro-RO"
  • "fr-CA"
  • "en-AT"
  • "pt-PT"
  • "fr-BE"
  • "en-SE"
  • "es-ES"
  • "en-ES"
  • "it-CH"
  • "el-GR"
  • "nl-NL"
  • "fi-FI"
  • "da-DK"
  • "en-DK"
  • "en-BE"
  • "en-FI"
  • "sv-SE"
  • "de-CH"
  • "en-NO"
  • "en-DE"
  • "it-IT"
  • "en-NL"
  • "en-GB"
  • "en-PL"
  • "de-AT"
  • "en-AU"
  • "cs-CZ"
payment_method_options.klarna.currency String No
payment_method_options.klarna.subscriptions No
payment_method_options.link Object No
payment_method_options.us_bank_account Object No
payment_method_options.us_bank_account.networks Object No
payment_method_options.us_bank_account.networks.requested[] Array No
payment_method_options.us_bank_account.mandate_options Object No
payment_method_options.us_bank_account.mandate_options.collection_method String No

Possible values:

  • ""
  • "paper"
payment_method_options.us_bank_account.financial_connections Object No
payment_method_options.us_bank_account.financial_connections.filters Object No
payment_method_options.us_bank_account.financial_connections.filters.account_subcategories[] Array No
payment_method_options.us_bank_account.financial_connections.permissions[] Array No
payment_method_options.us_bank_account.financial_connections.prefetch[] Array No
payment_method_options.us_bank_account.financial_connections.return_url String No
payment_method_options.us_bank_account.verification_method String No

Possible values:

  • "microdeposits"
  • "automatic"
  • "instant"
payment_method_options.acss_debit Object No
payment_method_options.acss_debit.mandate_options Object No
payment_method_options.acss_debit.mandate_options.custom_mandate_url No
payment_method_options.acss_debit.mandate_options.payment_schedule String No

Possible values:

  • "interval"
  • "sporadic"
  • "combined"
payment_method_options.acss_debit.mandate_options.transaction_type String No

Possible values:

  • "business"
  • "personal"
payment_method_options.acss_debit.mandate_options.interval_description String No
payment_method_options.acss_debit.mandate_options.default_for[] Array No
payment_method_options.acss_debit.verification_method String No

Possible values:

  • "microdeposits"
  • "automatic"
  • "instant"
payment_method_options.acss_debit.currency String No

Possible values:

  • "cad"
  • "usd"
payment_method_options.sepa_debit Object No
payment_method_options.sepa_debit.mandate_options Object No
payment_method_options.sepa_debit.mandate_options.reference_prefix No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.