# Update a SetupIntent Updates a SetupIntent object. ## Prerequisites Before you can run the following code snippet, you need to call these APIs with the provided parameters to set up the prerequisite API object(s). 1. createSetupIntent POST /v1/setup_intents {"payment_method_types":["card"]} ## Request ```curl curl https://api.stripe.com/v1/setup_intents/{{SETUP_INTENT_ID}} \ -u "<>" \ -d "metadata[order_id]=6735" ``` ### 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": { "order_id": "6735" }, "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" } ``` ## Returns Returns a SetupIntent object. ## Parameters - `allowed_payment_method_types` (array of enums, optional) The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object.md#payment_method_object-type). Possible enum values: - `acss_debit` [Pre-authorized debit payments](https://docs.stripe.com/docs/payments/acss-debit.md) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS). - `affirm` [Affirm](https://docs.stripe.com/docs/payments/affirm.md) is a buy now, pay later payment method in the US. - `afterpay_clearpay` [Afterpay / Clearpay](https://docs.stripe.com/docs/payments/afterpay-clearpay.md) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US. - `alipay` [Alipay](https://docs.stripe.com/docs/payments/alipay.md) is a digital wallet payment method used in China. - `alma` [Alma](https://docs.stripe.com/docs/payments/alma.md) is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments. - `amazon_pay` [Amazon Pay](https://docs.stripe.com/docs/payments/amazon-pay.md) is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day. - `au_becs_debit` [BECS Direct Debit](https://docs.stripe.com/docs/payments/au-becs-debit.md) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS). - `bacs_debit` [Bacs Direct Debit](https://docs.stripe.com/docs/payments/payment-methods/bacs-debit.md) is used to debit UK bank accounts. - `bancontact` [Bancontact](https://docs.stripe.com/docs/payments/bancontact.md) is a bank redirect payment method used in Belgium. - `billie` [Billie](https://docs.stripe.com/docs/payments/billie.md) is a payment method. - `bizum` [Bizum](https://docs.stripe.com/docs/payments/bizum.md) is a payment method. - `blik` [BLIK](https://docs.stripe.com/docs/payments/blik.md) is a single-use payment method common in Poland. - `boku_promptpay` PromptPay is a payment method. - `boleto` [Boleto](https://docs.stripe.com/docs/payments/boleto.md) is a voucher-based payment method used in Brazil. - `capchase_pay` CapchasePay is a payment method. - `card` [Card payments](https://docs.stripe.com/docs/payments/payment-methods/overview.md#cards) are supported through many networks, card brands, and select Link funding sources (Link is also known as Onelink in the UK). - `card_present` [Stripe Terminal](https://docs.stripe.com/docs/terminal/payments/collect-card-payment.md) is used to collect in-person card payments. - `cashapp` [Cash App Pay](https://docs.stripe.com/docs/payments/cash-app-pay.md) enables customers to frictionlessly authenticate payments in the Cash App using their stored balance or linked card. - `check_scan` CheckScan is a payment method. - `click_to_pay` ClickToPay is a payment method. - `crypto` [Stablecoin payments](https://docs.stripe.com/docs/payments/stablecoin-payments.md) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. - `customer_balance` Uses a customer’s [cash balance](https://docs.stripe.com/docs/payments/customer-balance.md) for the payment. - `demo_pay` DemoPay is a payment method. - `duitnow` Duitnow is a payment method. - `dummy_auth_push` Dummy auth push payment method for internal testing. - `dummy_passthrough_card` Dummy auth push payment method for internal testing. - `edenred` [Edenred](https://docs.stripe.com/docs/payments/edenred.md) is a payment method. - `eps` [EPS](https://docs.stripe.com/docs/payments/eps.md) is an Austria-based bank redirect payment method. - `fpx` [FPX](https://docs.stripe.com/docs/payments/fpx.md) is a Malaysia-based bank redirect payment method. - `gcash` GCash is a payment method. - `getbalance` [Getbalance](https://docs.stripe.com/docs/payments/getbalance.md) is a payment method. - `gift_card` Gift card is a payment method for redeeming third-party gift cards. - `giropay` [giropay](https://docs.stripe.com/docs/payments/giropay.md) is a German bank redirect payment method. - `gopay` Gopay is a payment method. - `grabpay` [GrabPay](https://docs.stripe.com/docs/payments/grabpay.md) is a digital wallet payment method used in Southeast Asia. - `id_bank_transfer` [Indonesia bank transfer](https://docs.stripe.com/docs/payments/id-bank-transfer.md) payments are used to accept bank transfers from customers in Indonesia. - `ideal` [iDEAL](https://docs.stripe.com/docs/payments/ideal.md) is a Netherlands-based bank redirect payment method. - `interac_present` [Stripe Terminal](https://docs.stripe.com/docs/terminal/payments/collect-card-payment.md) accepts [Interac](https://docs.stripe.com/docs/terminal/payments/regional.md?integration-country=CA#interac-payments) debit cards for in-person payments in Canada. - `kakao_pay` [Kakao Pay](https://docs.stripe.com/docs/payments/kakao-pay/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `klarna` [Klarna](https://docs.stripe.com/docs/payments/klarna.md) is a global buy now, pay later payment method. - `knet` KNET is a bank redirect payment method used in Kuwait. - `konbini` [Konbini](https://docs.stripe.com/docs/payments/konbini.md) is a cash-based voucher payment method used in Japan. - `kr_card` [Korean cards](https://docs.stripe.com/docs/payments/kr-card/accept-a-payment.md) enables customers to accept local credit and debit cards in South Korea. - `kr_market` KrMarket is a payment method. - `kriya` Kriya is a payment method. - `link` [Link (also known as Onelink in the UK)](https://docs.stripe.com/docs/payments/link.md) allows customers to pay with their saved payment details. - `mb_way` MB WAY is a payment method. - `mobilepay` [MobilePay](https://docs.stripe.com/docs/payments/mobilepay.md) is a Nordic card-passthrough wallet payment method where customers authorize the payment in the MobilePay application. - `momo` Momo is a payment method. - `mondu` [Mondu](https://docs.stripe.com/docs/payments/mondu.md) is a payment method. - `multibanco` [Multibanco](https://docs.stripe.com/docs/payments/multibanco.md) is a voucher payment method - `naver_pay` [Naver Pay](https://docs.stripe.com/docs/payments/naver-pay/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `netbanking` [NetBanking](https://docs.stripe.com/docs/payments/netbanking.md) is a bank redirect payment method used in India. - `ng_bank` Naira wallet is a payment method. - `ng_bank_transfer` Naira bank transfer is a payment method. - `ng_card` Naira card is a payment method. - `ng_market` NgMarket is a payment method. - `ng_ussd` Naira USSD is a payment method used in Nigeria to power USSD payments. - `ng_wallet` NgWallet is a payment method. - `nz_bank_account` [New Zealand BECS Direct Debit](https://docs.stripe.com/docs/payments/nz-bank-account.md) is used to debit New Zealand bank accounts through the Bulk Electronic Clearing System (BECS). - `octopus` [Octopus](https://docs.stripe.com/docs/payments/octopus.md) is a payment method. - `oxxo` [OXXO](https://docs.stripe.com/docs/payments/oxxo.md) is a cash-based voucher payment method used in Mexico. - `p24` [Przelewy24](https://docs.stripe.com/docs/payments/p24.md) is a bank redirect payment method used in Poland. - `paper_check` PaperCheck is a payment method. - `pay_by_bank` [Pay By Bank](https://docs.stripe.com/docs/payments/pay-by-bank.md) is an open banking payment method in the UK. - `payco` [PAYCO](https://docs.stripe.com/docs/payments/payco/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `paynow` [PayNow](https://docs.stripe.com/docs/payments/paynow.md) is a QR code payment method used in Singapore. - `paypal` [PayPal](https://docs.stripe.com/docs/payments/paypal.md) is an online wallet and redirect payment method commonly used in Europe. - `paypay` [PayPay](https://docs.stripe.com/docs/payments/paypay.md) is a payment method. - `payto` [PayTo](https://docs.stripe.com/docs/payments/payto.md) is a real time payment method - `pix` [Pix](https://docs.stripe.com/docs/payments/pix.md) is an instant bank transfer payment method in Brazil. - `promptpay` [PromptPay](https://docs.stripe.com/docs/payments/promptpay.md) is an instant funds transfer service popular in Thailand. - `qris` [QRIS](https://docs.stripe.com/docs/payments/qris.md) is a QR Code payment method in Indonesia. - `rechnung` [Rechnung](https://docs.stripe.com/docs/payments/rechnung.md) is a buy now, pay later payment option in Germany using white-label invoicing. - `revolut_pay` [Revolut Pay](https://docs.stripe.com/docs/payments/revolut-pay.md) is a digital wallet payment method used in the United Kingdom. - `samsung_pay` [Samsung Pay](https://docs.stripe.com/docs/payments/samsung-pay/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `satispay` [Satispay](https://docs.stripe.com/docs/payments/satispay.md) is a payment method. - `scalapay` Scalapay is a payment method. - `sepa_debit` [SEPA Direct Debit](https://docs.stripe.com/docs/payments/sepa-debit.md) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region. - `sequra` Sequra is a payment method. - `shop_pay` [Shop Pay](https://docs.stripe.com/docs/payments/shop-pay.md) is a Wallet payment method that lets hundreds of millions of Shopify customers pay their way, every day. - `shopeepay` Shopeepay is a payment method. - `sofort` [Sofort](https://docs.stripe.com/docs/payments/sofort.md) is a bank redirect payment method used in Europe. - `south_korea_market` SouthKoreaMarket is a payment method. - `stripe_balance` [Pay with Stripe balance](https://docs.stripe.com/docs/payments/balance-pay.md) is a payment method linked directly to a Stripe account’s available balance. - `sunbit` [Sunbit](https://docs.stripe.com/docs/payments/sunbit.md) is a payment method. - `swish` [Swish](https://docs.stripe.com/docs/payments/swish.md) is a Swedish wallet payment method where customers authorize the payment in the Swish application. - `tamara` [Tamara](https://docs.stripe.com/docs/payments/tamara.md) is a payment method. - `test_pay` TestPay is a payment method. - `truemoney` TrueMoney is a payment method. - `twint` [TWINT](https://docs.stripe.com/docs/payments/twint.md) is a single-use payment method used in Switzerland. - `upi` [UPI](https://docs.stripe.com/docs/payments/upi.md) is an instant real-time payment system in India. - `us_bank_account` [ACH Direct Debit](https://docs.stripe.com/docs/payments/ach-direct-debit.md) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system. - `us_cash_voucher` UsCashVoucher enables Treasury customers to add cash to their account using a voucher at select major US retailers. - `vipps` [Vipps](https://docs.stripe.com/docs/payments/vipps.md) is a Nordic card-passthrough wallet payment method where customers authorize the payment in the Vipps application. - `wechat_pay` [WeChat Pay](https://docs.stripe.com/docs/payments/wechat-pay.md) is a digital wallet payment method based in China. - `wero` Wero is a payment method. - `zip` [Zip](https://docs.stripe.com/docs/payments/zip.md) is a Buy now, pay later Payment Method - `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. - `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](https://docs.stripe.com/docs/payments/acss-debit.md) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS). - `affirm` [Affirm](https://docs.stripe.com/docs/payments/affirm.md) is a buy now, pay later payment method in the US. - `afterpay_clearpay` [Afterpay / Clearpay](https://docs.stripe.com/docs/payments/afterpay-clearpay.md) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US. - `alipay` [Alipay](https://docs.stripe.com/docs/payments/alipay.md) is a digital wallet payment method used in China. - `alma` [Alma](https://docs.stripe.com/docs/payments/alma.md) is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments. - `amazon_pay` [Amazon Pay](https://docs.stripe.com/docs/payments/amazon-pay.md) is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day. - `au_becs_debit` [BECS Direct Debit](https://docs.stripe.com/docs/payments/au-becs-debit.md) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS). - `bacs_debit` [Bacs Direct Debit](https://docs.stripe.com/docs/payments/payment-methods/bacs-debit.md) is used to debit UK bank accounts. - `bancontact` [Bancontact](https://docs.stripe.com/docs/payments/bancontact.md) is a bank redirect payment method used in Belgium. - `billie` [Billie](https://docs.stripe.com/docs/payments/billie.md) is a payment method. - `bizum` [Bizum](https://docs.stripe.com/docs/payments/bizum.md) is a payment method. - `blik` [BLIK](https://docs.stripe.com/docs/payments/blik.md) is a single-use payment method common in Poland. - `boleto` [Boleto](https://docs.stripe.com/docs/payments/boleto.md) is a voucher-based payment method used in Brazil. - `card` [Card payments](https://docs.stripe.com/docs/payments/payment-methods/overview.md#cards) are supported through many networks, card brands, and select Link funding sources (Link is also known as Onelink in the UK). - `card_present` [Stripe Terminal](https://docs.stripe.com/docs/terminal/payments/collect-card-payment.md) is used to collect in-person card payments. - `cashapp` [Cash App Pay](https://docs.stripe.com/docs/payments/cash-app-pay.md) enables customers to frictionlessly authenticate payments in the Cash App using their stored balance or linked card. - `crypto` [Stablecoin payments](https://docs.stripe.com/docs/payments/stablecoin-payments.md) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. - `customer_balance` Uses a customer’s [cash balance](https://docs.stripe.com/docs/payments/customer-balance.md) for the payment. - `eps` [EPS](https://docs.stripe.com/docs/payments/eps.md) is an Austria-based bank redirect payment method. - `fpx` [FPX](https://docs.stripe.com/docs/payments/fpx.md) is a Malaysia-based bank redirect payment method. - `giropay` [giropay](https://docs.stripe.com/docs/payments/giropay.md) is a German bank redirect payment method. - `grabpay` [GrabPay](https://docs.stripe.com/docs/payments/grabpay.md) is a digital wallet payment method used in Southeast Asia. - `ideal` [iDEAL](https://docs.stripe.com/docs/payments/ideal.md) is a Netherlands-based bank redirect payment method. - `interac_present` [Stripe Terminal](https://docs.stripe.com/docs/terminal/payments/collect-card-payment.md) accepts [Interac](https://docs.stripe.com/docs/terminal/payments/regional.md?integration-country=CA#interac-payments) debit cards for in-person payments in Canada. - `kakao_pay` [Kakao Pay](https://docs.stripe.com/docs/payments/kakao-pay/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `klarna` [Klarna](https://docs.stripe.com/docs/payments/klarna.md) is a global buy now, pay later payment method. - `konbini` [Konbini](https://docs.stripe.com/docs/payments/konbini.md) is a cash-based voucher payment method used in Japan. - `kr_card` [Korean cards](https://docs.stripe.com/docs/payments/kr-card/accept-a-payment.md) enables customers to accept local credit and debit cards in South Korea. - `mb_way` MB WAY is a payment method. - `mobilepay` [MobilePay](https://docs.stripe.com/docs/payments/mobilepay.md) is a Nordic card-passthrough wallet payment method where customers authorize the payment in the MobilePay application. - `multibanco` [Multibanco](https://docs.stripe.com/docs/payments/multibanco.md) is a voucher payment method - `naver_pay` [Naver Pay](https://docs.stripe.com/docs/payments/naver-pay/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `nz_bank_account` [New Zealand BECS Direct Debit](https://docs.stripe.com/docs/payments/nz-bank-account.md) is used to debit New Zealand bank accounts through the Bulk Electronic Clearing System (BECS). - `oxxo` [OXXO](https://docs.stripe.com/docs/payments/oxxo.md) is a cash-based voucher payment method used in Mexico. - `p24` [Przelewy24](https://docs.stripe.com/docs/payments/p24.md) is a bank redirect payment method used in Poland. - `pay_by_bank` [Pay By Bank](https://docs.stripe.com/docs/payments/pay-by-bank.md) is an open banking payment method in the UK. - `payco` [PAYCO](https://docs.stripe.com/docs/payments/payco/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `paynow` [PayNow](https://docs.stripe.com/docs/payments/paynow.md) is a QR code payment method used in Singapore. - `paypal` [PayPal](https://docs.stripe.com/docs/payments/paypal.md) is an online wallet and redirect payment method commonly used in Europe. - `paypay` [PayPay](https://docs.stripe.com/docs/payments/paypay.md) is a payment method. - `payto` [PayTo](https://docs.stripe.com/docs/payments/payto.md) is a real time payment method - `pix` [Pix](https://docs.stripe.com/docs/payments/pix.md) is an instant bank transfer payment method in Brazil. - `promptpay` [PromptPay](https://docs.stripe.com/docs/payments/promptpay.md) is an instant funds transfer service popular in Thailand. - `revolut_pay` [Revolut Pay](https://docs.stripe.com/docs/payments/revolut-pay.md) is a digital wallet payment method used in the United Kingdom. - `samsung_pay` [Samsung Pay](https://docs.stripe.com/docs/payments/samsung-pay/accept-a-payment.md) is a digital wallet payment method used in South Korea. - `satispay` [Satispay](https://docs.stripe.com/docs/payments/satispay.md) is a payment method. - `scalapay` Scalapay is a payment method. - `sepa_debit` [SEPA Direct Debit](https://docs.stripe.com/docs/payments/sepa-debit.md) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region. - `sofort` [Sofort](https://docs.stripe.com/docs/payments/sofort.md) is a bank redirect payment method used in Europe. - `sunbit` [Sunbit](https://docs.stripe.com/docs/payments/sunbit.md) is a payment method. - `swish` [Swish](https://docs.stripe.com/docs/payments/swish.md) is a Swedish wallet payment method where customers authorize the payment in the Swish application. - `twint` [TWINT](https://docs.stripe.com/docs/payments/twint.md) is a single-use payment method used in Switzerland. - `upi` [UPI](https://docs.stripe.com/docs/payments/upi.md) is an instant real-time payment system in India. - `us_bank_account` [ACH Direct Debit](https://docs.stripe.com/docs/payments/ach-direct-debit.md) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system. - `wechat_pay` [WeChat Pay](https://docs.stripe.com/docs/payments/wechat-pay.md) is a digital wallet payment method based in China. - `zip` [Zip](https://docs.stripe.com/docs/payments/zip.md) 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 - `metadata` (map, optional) Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata.md) 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` (string, optional) 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_configuration` (string, optional) The ID of the [payment method configuration](https://docs.stripe.com/docs/api/payment_method_configurations.md) to use with this SetupIntent. The maximum length is 100 characters. - [`payment_method_data`](https://docs.stripe.com/api/setup_intents/update.md?query=payment_method_data) (object, optional) When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/docs/api/setup_intents/object.md#setup_intent_object-payment_method) value in the SetupIntent. - [`payment_method_options`](https://docs.stripe.com/api/setup_intents/update.md?query=payment_method_options) (object, optional) Payment method-specific configuration for this SetupIntent. - `payment_method_types` (array of strings, optional) 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](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object.md#payment_method_object-type).