Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.
If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_
status and suggest additional actions via next_
. If payment fails, the PaymentIntent transitions to the requires_
status or the canceled
status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded
status (or requires_
, if capture_
is set to manual
).
If the confirmation_
is automatic
, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_
s are handled by the client, no additional confirmation is required to complete the payment.
If the confirmation_
is manual
, all payment attempts must be initiated using a secret key.
If any actions are required for the payment, the PaymentIntent will return to the requires_
state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.
There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled
state.
Parameters
- payment_
methodstring ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the customer that is set on this PaymentIntent.
- receipt_
emailstring Email address that the receipt for the resulting payment will be sent to. If
receipt_
is specified for a payment in live mode, a receipt will be sent regardless of your email settings.email - setup_
future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesoff_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - shippingobject
Shipping information for this PaymentIntent.
- shipping.
addressobjectRequired Shipping address.
- shipping.
address. citystring City, district, suburb, town, or village.
- shipping.
address. countrystringRequired for calculating taxes Two-letter country code (ISO 3166-1 alpha-2).
- shipping.
address. line1string Address line 1 (e.g., street, PO Box, or company name).
- shipping.
address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- shipping.
address. postal_ codestringRequired for calculating taxes ZIP or postal code.
- shipping.
address. statestring State, county, province, or region.
- shipping.
namestringRequired Recipient name.
- shipping.
carrierstring The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
- shipping.
phonestring Recipient phone (including extension).
- shipping.
tracking_ numberstring The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
More parameters
- capture_
methodenumsecret key only Controls when the funds will be captured from the customer’s account.
Possible enum valuesautomatic
Stripe automatically captures funds when the customer authorizes the payment.
automatic_
async (Default) Stripe asynchronously captures funds when the customer authorizes the payment. Recommended over
capture_
due to improved latency. Read the integration guide for more information.method=automatic manual
Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.)
- confirmation_
tokenstring ID of the ConfirmationToken used to confirm this PaymentIntent.
If the provided ConfirmationToken contains properties that are also being provided in this request, such as
payment_
, then the values in this request will take precedence.method - error_
on_ requires_ actionboolean Set to
true
to fail the payment attempt if the PaymentIntent transitions intorequires_
. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.action - mandatestringsecret key only
ID of the mandate that’s used for this payment.
- mandate_
dataobject This hash contains details about the mandate to create.
- mandate_data.
customer_ acceptanceobjectRequired This hash contains details about the customer acceptance of the Mandate.
- mandate_data.
customer_acceptance. typestringRequired The type of customer acceptance information included with the Mandate. One of
online
oroffline
. - mandate_data.
customer_acceptance. accepted_ attimestampsecret key only The time at which the customer accepted the Mandate.
- mandate_data.
customer_acceptance. offlineobject If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
- mandate_data.
customer_acceptance. onlineobject If this is a Mandate accepted online, this hash contains details about the online acceptance.
- mandate_data.
customer_acceptance. online. ip_ addressstringRequired The IP address from which the Mandate was accepted by the customer.
- mandate_data.
customer_acceptance. online. user_ agentstringRequired The user agent of the browser from which the Mandate was accepted by the customer.
- off_
sessionboolean | stringsecret key only Set to
true
to indicate that the customer isn’t in your checkout flow during this payment attempt and can’t authenticate. Use this parameter in scenarios where you collect card details and charge them later. - payment_
method_ dataobject If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.
- payment_method_data.
typeenumRequired The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
- payment_method_data.
acss_ debitobject If this is an
acss_
PaymentMethod, this hash contains details about the ACSS Debit payment method.debit - payment_method_data.
acss_debit. account_ numberstringRequired Customer’s bank account number.
- payment_method_data.
acss_debit. institution_ numberstringRequired Institution number of the customer’s bank.
- payment_method_data.
acss_debit. transit_ numberstringRequired Transit number of the customer’s bank.
- payment_method_data.
affirmobject If this is an
affirm
PaymentMethod, this hash contains details about the Affirm payment method. - payment_method_data.
afterpay_ clearpayobject If this is an
AfterpayClearpay
PaymentMethod, this hash contains details about the AfterpayClearpay payment method. - payment_method_data.
alipayobject If this is an
Alipay
PaymentMethod, this hash contains details about the Alipay payment method. - payment_method_data.
allow_ redisplayenum This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to
unspecified
.Possible enum valuesalways
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_
wasn’t set.redisplay - payment_method_data.
almaobject If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
- payment_method_data.
amazon_ payobject If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
- payment_method_data.
au_ becs_ debitobject If this is an
au_
PaymentMethod, this hash contains details about the bank account.becs_ debit - payment_method_data.
au_becs_debit. account_ numberstringRequired The account number for the bank account.
- payment_method_data.
au_becs_debit. bsb_ numberstringRequired Bank-State-Branch number of the bank account.
- payment_method_data.
bacs_ debitobject If this is a
bacs_
PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.debit - payment_method_data.
bacs_debit. account_ numberstring Account number of the bank account that the funds will be debited from.
- payment_method_data.
bacs_debit. sort_ codestring Sort code of the bank account. (e.g.,
10-20-30
)
- payment_method_data.
bancontactobject If this is a
bancontact
PaymentMethod, this hash contains details about the Bancontact payment method. - payment_method_data.
billieobject If this is a
billie
PaymentMethod, this hash contains details about the Billie payment method. - payment_method_data.
billing_ detailsobject Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- payment_method_data.
billing_details. addressobject Billing address.
- payment_method_data.
billing_details. address. citystring City, district, suburb, town, or village.
- payment_method_data.
billing_details. address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- payment_method_data.
billing_details. address. line1string Address line 1 (e.g., street, PO Box, or company name).
- payment_method_data.
billing_details. address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- payment_method_data.
billing_details. address. postal_ codestring ZIP or postal code.
- payment_method_data.
billing_details. address. statestring State, county, province, or region.
- payment_method_data.
billing_details. emailstring Email address.
- payment_method_data.
billing_details. namestring Full name.
- payment_method_data.
billing_details. phonestring Billing phone number (including extension).
- payment_method_data.
billing_details. tax_ idstring Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
- payment_method_data.
blikobject If this is a
blik
PaymentMethod, this hash contains details about the BLIK payment method. - payment_method_data.
boletoobject If this is a
boleto
PaymentMethod, this hash contains details about the Boleto payment method.- payment_method_data.
boleto. tax_ idstringRequired The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
- payment_method_data.
cashappobject If this is a
cashapp
PaymentMethod, this hash contains details about the Cash App Pay payment method. - payment_method_data.
cryptoobject If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
- payment_method_data.
customer_ balanceobject If this is a
customer_
PaymentMethod, this hash contains details about the CustomerBalance payment method.balance - payment_method_data.
epsobject If this is an
eps
PaymentMethod, this hash contains details about the EPS payment method.- payment_method_data.
eps. bankstring The customer’s bank.
- payment_method_data.
fpxobject If this is an
fpx
PaymentMethod, this hash contains details about the FPX payment method.- payment_method_data.
fpx. bankstringRequired The customer’s bank.
- payment_method_data.
giropayobject If this is a
giropay
PaymentMethod, this hash contains details about the Giropay payment method. - payment_method_data.
grabpayobject If this is a
grabpay
PaymentMethod, this hash contains details about the GrabPay payment method. - payment_method_data.
idealobject If this is an
ideal
PaymentMethod, this hash contains details about the iDEAL payment method.- payment_method_data.
ideal. bankstring The customer’s bank. Only use this parameter for existing customers. Don’t use it for new customers.
- payment_method_data.
interac_ presentobjectPreview feature If this is an
interac_
PaymentMethod, this hash contains details about the Interac Present payment method.present - payment_method_data.
kakao_ payobject If this is a
kakao_
PaymentMethod, this hash contains details about the Kakao Pay payment method.pay - payment_method_data.
klarnaobject If this is a
klarna
PaymentMethod, this hash contains details about the Klarna payment method.- payment_method_data.
klarna. dobobject Customer’s date of birth
- payment_method_data.
klarna. dob. dayintegerRequired The day of birth, between 1 and 31.
- payment_method_data.
klarna. dob. monthintegerRequired The month of birth, between 1 and 12.
- payment_method_data.
klarna. dob. yearintegerRequired The four-digit year of birth.
- payment_method_data.
konbiniobject If this is a
konbini
PaymentMethod, this hash contains details about the Konbini payment method. - payment_method_data.
kr_ cardobject If this is a
kr_
PaymentMethod, this hash contains details about the Korean Card payment method.card - payment_method_data.
linkobject If this is an
Link
PaymentMethod, this hash contains details about the Link payment method. - payment_method_data.
metadataobject Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - payment_method_data.
mobilepayobject If this is a
mobilepay
PaymentMethod, this hash contains details about the MobilePay payment method. - payment_method_data.
multibancoobject If this is a
multibanco
PaymentMethod, this hash contains details about the Multibanco payment method. - payment_method_data.
object If this is a
naver_
PaymentMethod, this hash contains details about the Naver Pay payment method.pay - payment_method_data.
naver_pay. enum Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to
card
.Possible enum valuescard
Use a card to fund this transaction.
points
Use Naver Pay points to fund this transaction.
- payment_method_data.
nz_ bank_ accountobject If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
- payment_method_data.
nz_bank_account. account_ numberstringRequired The account number for the bank account.
- payment_method_data.
nz_bank_account. bank_ codestringRequired The numeric code for the bank account’s bank.
- payment_method_data.
nz_bank_account. branch_ codestringRequired The numeric code for the bank account’s bank branch.
- payment_method_data.
nz_bank_account. suffixstringRequired The suffix of the bank account number.
- payment_method_data.
nz_bank_account. account_ holder_ namestring The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
- payment_method_data.
oxxoobject If this is an
oxxo
PaymentMethod, this hash contains details about the OXXO payment method. - payment_method_data.
p24object If this is a
p24
PaymentMethod, this hash contains details about the P24 payment method.- payment_method_data.
p24. bankenum The customer’s bank.
- payment_method_data.
pay_ by_ bankobject If this is a
pay_
PaymentMethod, this hash contains details about the PayByBank payment method.by_ bank - payment_method_data.
paycoobject If this is a
payco
PaymentMethod, this hash contains details about the PAYCO payment method. - payment_method_data.
paynowobject If this is a
paynow
PaymentMethod, this hash contains details about the PayNow payment method. - payment_method_data.
paypalobject If this is a
paypal
PaymentMethod, this hash contains details about the PayPal payment method. - payment_method_data.
pixobject If this is a
pix
PaymentMethod, this hash contains details about the Pix payment method. - payment_method_data.
promptpayobject If this is a
promptpay
PaymentMethod, this hash contains details about the PromptPay payment method. - payment_method_data.
radar_ optionsobject Options to configure Radar. See Radar Session for more information.
- payment_method_data.
radar_options. sessionstringsecret key only A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
- payment_method_data.
revolut_ payobject If this is a
revolut_
PaymentMethod, this hash contains details about the Revolut Pay payment method.pay - payment_method_data.
samsung_ payobject If this is a
samsung_
PaymentMethod, this hash contains details about the SamsungPay payment method.pay - payment_method_data.
satispayobject If this is a
satispay
PaymentMethod, this hash contains details about the Satispay payment method. - payment_method_data.
sepa_ debitobject If this is a
sepa_
PaymentMethod, this hash contains details about the SEPA debit bank account.debit - payment_method_data.
sepa_debit. ibanstringRequired IBAN of the bank account.
- payment_method_data.
sofortobject If this is a
sofort
PaymentMethod, this hash contains details about the SOFORT payment method.- payment_method_data.
sofort. countryenumRequired Two-letter ISO code representing the country the bank account is located in.
Possible enum valuesAT
Austria
BE
Belgium
DE
Germany
ES
Spain
IT
Italy
NL
Netherlands
- payment_method_data.
swishobject If this is a
swish
PaymentMethod, this hash contains details about the Swish payment method. - payment_method_data.
twintobject If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
- payment_method_data.
us_ bank_ accountobject If this is an
us_
PaymentMethod, this hash contains details about the US bank account payment method.bank_ account - payment_method_data.
us_bank_account. account_ holder_ typeenum Account holder type: individual or company.
Possible enum valuescompany
Account belongs to a company
individual
Account belongs to an individual
- payment_method_data.
us_bank_account. account_ numberstring Account number of the bank account.
- payment_method_data.
us_bank_account. account_ typeenum Account type: checkings or savings. Defaults to checking if omitted.
Possible enum valueschecking
Bank account type is checking
savings
Bank account type is savings
- payment_method_data.
us_bank_account. financial_ connections_ accountstring The ID of a Financial Connections Account to use as a payment method.
- payment_method_data.
us_bank_account. routing_ numberstring Routing number of the bank account.
- payment_method_data.
wechat_ payobject If this is an
wechat_
PaymentMethod, this hash contains details about the wechat_pay payment method.pay - payment_method_data.
zipobject If this is a
zip
PaymentMethod, this hash contains details about the Zip payment method.
- payment_
method_ optionsobjectsecret key only Payment method-specific configuration for this PaymentIntent.
- payment_method_options.
acss_ debitobject If this is a
acss_
PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.debit - payment_method_options.
acss_debit. mandate_ optionsobject Additional fields for Mandate creation
- payment_method_options.
acss_debit. mandate_options. custom_ mandate_ urlstring A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters
payment_
andintent payment_
when confirming a Payment Intent, orintent_ client_ secret setup_
andintent setup_
when confirming a Setup Intent.intent_ client_ secret - payment_method_options.
acss_debit. mandate_options. interval_ descriptionstring Description of the mandate interval. Only required if ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.
- payment_method_options.
acss_debit. mandate_options. payment_ scheduleenum Payment schedule for the mandate.
Possible enum valuescombined
Payments can be initiated at a pre-defined interval or sporadically
interval
Payments are initiated at a regular pre-defined interval
sporadic
Payments are initiated sporadically
- payment_method_options.
acss_debit. mandate_options. transaction_ typeenum Transaction type of the mandate.
Possible enum valuesbusiness
Transactions are made for business reasons
personal
Transactions are made for personal reasons
- payment_method_options.
acss_debit. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
acss_debit. target_ datestring Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
- payment_method_options.
acss_debit. verification_ methodenum Bank account verification method.
Possible enum valuesautomatic
Instant verification with fallback to microdeposits.
instant
Instant verification.
microdeposits
Verification using microdeposits.
- payment_method_options.
affirmobject If this is an
affirm
PaymentMethod, this sub-hash contains details about the Affirm payment method options.- payment_method_options.
affirm. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
affirm. preferred_ localestring Preferred language of the Affirm authorization page that the customer is redirected to.
- payment_method_options.
affirm. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
afterpay_ clearpayobject If this is a
afterpay_
PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.clearpay - payment_method_options.
afterpay_clearpay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
afterpay_clearpay. referencestring An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes. This field differs from the statement descriptor and item name.
- payment_method_options.
afterpay_clearpay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
alipayobject If this is a
alipay
PaymentMethod, this sub-hash contains details about the Alipay payment method options.- payment_method_options.
alipay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
almaobject If this is a
alma
PaymentMethod, this sub-hash contains details about the Alma payment method options.- payment_method_options.
alma. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method
- payment_method_options.
amazon_ payobject If this is a
amazon_
PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.pay - payment_method_options.
amazon_pay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
amazon_pay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
au_ becs_ debitobject If this is a
au_
PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.becs_ debit - payment_method_options.
au_becs_debit. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
au_becs_debit. target_ datestring Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
- payment_method_options.
bacs_ debitobject If this is a
bacs_
PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.debit - payment_method_options.
bacs_debit. mandate_ optionsobject Additional fields for Mandate creation
- payment_method_options.
bacs_debit. mandate_options. reference_ prefixstringPreview feature Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘DDIC’ or ‘STRIPE’.
- payment_method_options.
bacs_debit. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
bacs_debit. target_ datestring Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
- payment_method_options.
bancontactobject If this is a
bancontact
PaymentMethod, this sub-hash contains details about the Bancontact payment method options.- payment_method_options.
bancontact. preferred_ languageenum Preferred language of the Bancontact authorization page that the customer is redirected to.
Possible enum valuesde
German
en
English
fr
French
nl
Dutch
- payment_method_options.
bancontact. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
billieobject If this is a
billie
PaymentMethod, this sub-hash contains details about the Billie payment method options.- payment_method_options.
billie. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method
- payment_method_options.
blikobject If this is a
blik
PaymentMethod, this sub-hash contains details about the BLIK payment method options.- payment_method_options.
blik. codestring The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
- payment_method_options.
blik. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
boletoobject If this is a
boleto
PaymentMethod, this sub-hash contains details about the Boleto payment method options.- payment_method_options.
boleto. expires_ after_ daysinteger The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
- payment_method_options.
boleto. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session
- payment_method_options.
cardobject Configuration for any card payments attempted on this PaymentIntent.
- payment_method_options.
card. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
card. cvc_ tokenstring A single-use
cvc_
Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.update - payment_method_options.
card. installmentsobject Installment configuration for payments attempted on this PaymentIntent.
For more information, see the installments integration guide.
- payment_method_options.
card. installments. enabledboolean Setting to true enables installments for this PaymentIntent. This will cause the response to contain a list of available installment plans. Setting to false will prevent any selected plan from applying to a charge.
- payment_method_options.
card. installments. planobject The selected installment plan to use for this payment attempt. This parameter can only be provided during confirmation.
- payment_method_options.
card. installments. plan. typeenumRequired Type of installment plan, one of
fixed_
,count bonus
, orrevolving
.Possible enum valuesbonus
An installment plan used in Japan, where the customer defers payment to a later date that aligns with their salary bonus.
fixed_
count An installment plan where the number of installment payments is fixed and known at the time of purchase.
revolving
An installment plan used in Japan, where the customer pays a certain amount each month, and the remaining balance rolls over to the next month.
- payment_method_options.
card. installments. plan. countinteger For
fixed_
installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.count - payment_method_options.
card. installments. plan. intervalenum For
fixed_
installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One ofcount month
.Possible enum valuesmonth
- payment_method_options.
card. mandate_ optionsobject Configuration options for setting up an eMandate for cards issued in India.
- payment_method_options.
card. mandate_options. amountintegerRequired Amount to be charged for future payments.
- payment_method_options.
card. mandate_options. amount_ typeenumRequired One of
fixed
ormaximum
. Iffixed
, theamount
param refers to the exact amount to be charged in future payments. Ifmaximum
, the amount charged can be up to the value passed for theamount
param.Possible enum valuesfixed
maximum
- payment_method_options.
card. mandate_options. intervalenumRequired Specifies payment frequency. One of
day
,week
,month
,year
, orsporadic
.Possible enum valuesday
month
sporadic
week
year
- payment_method_options.
card. mandate_options. referencestringRequired Unique identifier for the mandate or subscription.
- payment_method_options.
card. mandate_options. start_ datetimestampRequired Start date of the mandate or subscription. Start date should not be lesser than yesterday.
- payment_method_options.
card. mandate_options. descriptionstring A description of the mandate or subscription that is meant to be displayed to the customer.
- payment_method_options.
card. mandate_options. end_ datetimestamp End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
- payment_method_options.
card. mandate_options. interval_ countinteger The number of intervals between payments. For example,
interval=month
andinterval_
indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional whencount=3 interval=sporadic
. - payment_method_options.
card. mandate_options. supported_ typesarray of enums Specifies the type of mandates supported. Possible values are
india
.Possible enum valuesindia
- payment_method_options.
card. networkstring Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
- payment_method_options.
card. enum Request ability to capture beyond the standard authorization validity window for this PaymentIntent.
Possible enum valuesif_
available Use
if_
if you want to extend the capture window when eligible for extended authorization.available never
Use
never
if you don’t want to extend the capture window. - payment_method_options.
card. enum Request ability to increment the authorization for this PaymentIntent.
Possible enum valuesif_
available Use
if_
if you want to increment the authorization on the PaymentIntent when eligible.available never
Use
never
if you don’t want to increment the authorization on the PaymentIntent. - payment_method_options.
card. request_ multicaptureenum Request ability to make multiple captures for this PaymentIntent.
Possible enum valuesif_
available Use
if_
if you want to use multicapture when eligible.available never
Use
never
if you don’t want to use multicapture. - payment_method_options.
card. request_ overcaptureenum Request ability to overcapture for this PaymentIntent.
Possible enum valuesif_
available Use
if_
if you want to overcapture the payment when eligible.available never
Use
never
if you don’t want to overcapture the payment. - payment_method_options.
card. request_ three_ d_ secureenumadvanced We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to
automatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.Possible enum valuesany
Use
any
to manually request 3DS with a preference for africtionless
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 achallenge
flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide. - payment_method_options.
card. require_ cvc_ recollectionboolean When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
- payment_method_options.
card. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
card. statement_ descriptor_ suffix_ kanastring Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.
- payment_method_options.
card. statement_ descriptor_ suffix_ kanjistring Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.
- payment_method_options.
card. three_ d_ secureobject If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.
- payment_method_options.
card. three_d_secure. cryptogramstringRequired The cryptogram, also known as the “authentication value” (AAV, CAVV or AEVV). This value is 20 bytes, base64-encoded into a 28-character string. (Most 3D Secure providers will return the base64-encoded version, which is what you should specify here.)
- payment_method_options.
card. three_d_secure. transaction_ idstringRequired For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
- payment_method_options.
card. three_d_secure. versionenumRequired The version of 3D Secure that was performed.
- payment_method_options.
card. three_d_secure. ares_ trans_ statusenum The
transStatus
returned from the card Issuer’s ACS in the ARes.Possible enum valuesA
Attempts processing performed; Not authenticated/verified, but a proof of attempted authentication/verification is provided.
C
Challenge required; Additional authentication is required.
I
Informational only; 3DS Requestor challenge preference acknowledged.
N
Not authenticated/Account not verified; Transaction denied.
R
Authentication/Account verification rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted.
U
Authentication/Account verification could not be performed; Technical or other problem.
Y
Authentication verification successful.
- payment_method_options.
card. three_d_secure. electronic_ commerce_ indicatorenumRequired on all networks except cartes bancaires The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
Possible enum values01
Mastercard variant: Attempt acknowledged.
02
Mastercard variant: Fully authenticated.
05
Fully authenticated. The customer likely proved their identity to the issuing bank.
06
Attempt acknowledged. The customer, or the entire issuing bank, is not set up for 3D Secure. Or the issuing bank is experiencing an outage.
Mastercard variant: Acquirer SCA exemption.
07
Mastercard variant: Fully authenticated recurring transaction.
- payment_method_options.
card. three_d_secure. exemption_ indicatorenum The exemption requested via 3DS and accepted by the issuer at authentication time.
Possible enum valueslow_
risk Transaction Risk Analysis (TRA) was performed, a low risk exemption was requested via 3DS and granted by the issuer.
none
No exemption was requested via 3DS; or, if requested, it was not granted by the issuer.
- payment_method_options.
card. three_d_secure. network_ optionsobject Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
- payment_method_options.
card. three_d_secure. network_options. cartes_ bancairesobject Cartes Bancaires-specific 3DS fields.
- payment_method_options.
card. three_d_secure. network_options. cartes_bancaires. cb_ avalgoenumRequired The cryptogram calculation algorithm used by the card Issuer’s ACS to calculate the Authentication cryptogram. Also known as
cavvAlgorithm
. messageExtension: CB-AVALGOPossible enum values0
HMAC
1
CVV
2
CVV with ATN
3
Mastercard SPA
4
American Express SafeKey 1
A
AV-CB
- payment_method_options.
card. three_d_secure. network_options. cartes_bancaires. cb_ exemptionstring The exemption indicator returned from Cartes Bancaires in the ARes. message extension: CB-EXEMPTION; string (4 characters) This is a 3 byte bitmap (low significant byte first and most significant bit first) that has been Base64 encoded
- payment_method_options.
card. three_d_secure. network_options. cartes_bancaires. cb_ scoreinteger The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
- payment_method_options.
card. three_d_secure. requestor_ challenge_ indicatorstring The challenge indicator (
threeDSRequestorChallengeInd
) which was requested in the AReq sent to the card Issuer’s ACS. A string containing 2 digits from 01-99.
- payment_method_options.
card_ presentobject If this is a
card_
PaymentMethod, this sub-hash contains details about the Card Present payment method options.present - payment_method_options.
card_present. capture_ methodenumPreview feature Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method manual_
preferred Use
manual_
if you preferpreferred manual
capture_method but support falling back toautomatic
based on the presented payment method. - payment_method_options.
card_present. boolean Request ability to capture this payment beyond the standard authorization validity window
- payment_method_options.
card_present. boolean Request ability to increment this PaymentIntent if the combination of MCC and card brand is eligible. Check incremental_authorization_supported in the Confirm response to verify support.
- payment_method_options.
card_present. routingobject Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
- payment_method_options.
card_present. routing. requested_ priorityenum Routing requested priority
Possible enum valuesdomestic
Prioritize domestic debit network routing on payment method collection
international
Prioritize international network routing on payment method collection
- payment_method_options.
cashappobject If this is a
cashapp
PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.- payment_method_options.
cashapp. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
cashapp. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session
- payment_method_options.
cryptoobject If this is a
crypto
PaymentMethod, this sub-hash contains details about the Crypto payment method options.- payment_method_options.
crypto. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
customer_ balanceobject If this is a
customer balance
PaymentMethod, this sub-hash contains details about the customer balance payment method options.- payment_method_options.
customer_balance. bank_ transferobject Configuration for the bank transfer funding type, if the
funding_
is set totype bank_
.transfer - payment_method_options.
customer_balance. bank_transfer. typeenumRequired The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include:
eu_
,bank_ transfer gb_
,bank_ transfer jp_
,bank_ transfer mx_
, orbank_ transfer us_
.bank_ transfer Possible enum valueseu_
bank_ transfer eu_bank_transfer bank transfer type
gb_
bank_ transfer gb_bank_transfer bank transfer type
jp_
bank_ transfer jp_bank_transfer bank transfer type
mx_
bank_ transfer mx_bank_transfer bank transfer type
us_
bank_ transfer us_bank_transfer bank transfer type
- payment_method_options.
customer_balance. bank_transfer. eu_ bank_ transferobject Configuration for the eu_bank_transfer funding type.
- payment_method_options.
customer_balance. bank_transfer. eu_bank_transfer. countrystringRequired The desired country code of the bank account information. Permitted values include:
BE
,DE
,ES
,FR
,IE
, orNL
.
- payment_method_options.
customer_balance. bank_transfer. requested_ address_ typesarray of enums List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
Permitted values include:
sort_
,code zengin
,iban
, orspei
.Possible enum valuesaba
aba bank account address type
iban
iban bank account address type
sepa
sepa bank account address type
sort_
code sort_code bank account address type
spei
spei bank account address type
swift
swift bank account address type
zengin
zengin bank account address type
- payment_method_options.
customer_balance. funding_ typeenum The funding method type to be used when there are not enough funds in the customer balance. Permitted values include:
bank_
.transfer Possible enum valuesbank_
transfer - payment_method_options.
customer_balance. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
epsobject If this is a
eps
PaymentMethod, this sub-hash contains details about the EPS payment method options.- payment_method_options.
eps. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
fpxobject If this is a
fpx
PaymentMethod, this sub-hash contains details about the FPX payment method options.- payment_method_options.
fpx. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
giropayobject If this is a
giropay
PaymentMethod, this sub-hash contains details about the Giropay payment method options.- payment_method_options.
giropay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
grabpayobject If this is a
grabpay
PaymentMethod, this sub-hash contains details about the Grabpay payment method options.- payment_method_options.
grabpay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
idealobject If this is a
ideal
PaymentMethod, this sub-hash contains details about the Ideal payment method options.- payment_method_options.
ideal. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
interac_ presentobjectPreview feature If this is a
interac_
PaymentMethod, this sub-hash contains details about the Card Present payment method options.present - payment_method_options.
kakao_ payobject If this is a
kakao_
PaymentMethod, this sub-hash contains details about the Kakao Pay payment method options.pay - payment_method_options.
kakao_pay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
kakao_pay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
klarnaobject If this is a
klarna
PaymentMethod, this sub-hash contains details about the Klarna payment method options.- payment_method_options.
klarna. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
klarna. on_ demandobject On-demand details if setting up or charging an on-demand payment.
- payment_method_options.
klarna. on_demand. average_ amountinteger Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
- payment_method_options.
klarna. on_demand. maximum_ amountinteger The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
- payment_method_options.
klarna. on_demand. minimum_ amountinteger The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
- payment_method_options.
klarna. on_demand. purchase_ intervalenum Interval at which the customer is making purchases
Possible enum valuesday
Use
day
if you expect one or more days between charges.month
Use
month
if you expect one or more months between charges.week
Use
week
if you expect one or more weeks between charges.year
Use
year
if you expect one or more years between charges. - payment_method_options.
klarna. on_demand. purchase_ interval_ countinteger The number of
purchase_
between chargesinterval
- payment_method_options.
klarna. preferred_ localeenum Preferred language of the Klarna authorization page that the customer is redirected to
Possible enum valuescs-CZ
Czech - Czechia
da-DK
Danish - Denmark
de-AT
German - Austria
de-CH
German - Switzerland
de-DE
German - Germany
el-GR
Greek - Greece
en-AT
English - Austria
en-AU
English - Australia
en-BE
English - Belgium
en-CA
English - Canada
Show 36 more - payment_method_options.
klarna. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
klarna. subscriptionsarray of objects Subscription details if setting up or charging a subscription.
- payment_method_options.
klarna. subscriptions. intervalenumRequired Unit of time between subscription charges.
Possible enum valuesday
Use
day
if subscription charges occur within days.month
Use
month
if subscription charges occur within months.week
Use
week
if subscription charges occur within weeks.year
Use
year
if subscription charges occur within years. - payment_method_options.
klarna. subscriptions. referencestringRequired A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
- payment_method_options.
klarna. subscriptions. interval_ countinteger The number of intervals (specified in the
interval
attribute) between subscription charges. For example,interval=month
andinterval_
charges every 3 months.count=3 - payment_method_options.
klarna. subscriptions. namestring Name for subscription.
- payment_method_options.
klarna. subscriptions. next_ billingobject Describes the upcoming charge for this subscription.
- payment_method_options.
klarna. subscriptions. next_billing. amountintegerRequired The amount of the next charge for the subscription.
- payment_method_options.
klarna. subscriptions. next_billing. datestringRequired The date of the next charge for the subscription in YYYY-MM-DD format.
- payment_method_options.
konbiniobject If this is a
konbini
PaymentMethod, this sub-hash contains details about the Konbini payment method options.- payment_method_options.
konbini. confirmation_ numberstring An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer’s phone number.
- payment_method_options.
konbini. expires_ after_ daysinteger The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and
expires_
set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.after_ days - payment_method_options.
konbini. expires_ attimestamp The timestamp at which the Konbini payment instructions will expire. Only one of
expires_
orafter_ days expires_
may be set.at - payment_method_options.
konbini. product_ descriptionstring A product descriptor of up to 22 characters, which will appear to customers at the convenience store.
- payment_method_options.
konbini. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
kr_ cardobject If this is a
kr_
PaymentMethod, this sub-hash contains details about the KR Card payment method options.card - payment_method_options.
kr_card. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
kr_card. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
linkobject If this is a
link
PaymentMethod, this sub-hash contains details about the Link payment method options.- payment_method_options.
link. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
link. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
mobilepayobject If this is a
MobilePay
PaymentMethod, this sub-hash contains details about the MobilePay payment method options.- payment_method_options.
mobilepay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
mobilepay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
multibancoobject If this is a
multibanco
PaymentMethod, this sub-hash contains details about the Multibanco payment method options.- payment_method_options.
multibanco. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
object If this is a
naver_
PaymentMethod, this sub-hash contains details about the Naver Pay payment method options.pay - payment_method_options.
naver_pay. enum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
naver_pay. enum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
nz_ bank_ accountobject If this is a
nz_
PaymentMethod, this sub-hash contains details about the NZ BECS Direct Debit payment method options.bank_ account - payment_method_options.
nz_bank_account. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
nz_bank_account. target_ datestring Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
- payment_method_options.
oxxoobject If this is a
oxxo
PaymentMethod, this sub-hash contains details about the OXXO payment method options.- payment_method_options.
oxxo. expires_ after_ daysinteger The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
- payment_method_options.
oxxo. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
p24object If this is a
p24
PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.- payment_method_options.
p24. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage - payment_method_options.
p24. tos_ shown_ and_ acceptedboolean Confirm that the payer has accepted the P24 terms and conditions.
- payment_method_options.
pay_ by_ bankobject If this is a
pay_
PaymentMethod, this sub-hash contains details about the PayByBank payment method options.by_ bank - payment_method_options.
paycoobject If this is a
payco
PaymentMethod, this sub-hash contains details about the PAYCO payment method options.- payment_method_options.
payco. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method
- payment_method_options.
paynowobject If this is a
paynow
PaymentMethod, this sub-hash contains details about the PayNow payment method options.- payment_method_options.
paynow. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
paypalobject If this is a
paypal
PaymentMethod, this sub-hash contains details about the PayPal payment method options.- payment_method_options.
paypal. capture_ methodenum Controls when the funds will be captured from the customer’s account.
Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
paypal. preferred_ localeenum Preferred locale of the PayPal checkout page that the customer is redirected to.
Possible enum valuescs-CZ
Czech - The Czech Republic
da-DK
Danish - Denmark
de-AT
German - Austria
de-DE
German - Germany
de-LU
German - Luxembourg
el-GR
Greek - Greece
en-GB
English - United Kingdom
en-US
English - United States of America
es-ES
Spanish - Spain
fi-FI
Finnish - Finland
Show 11 more - payment_method_options.
paypal. referencestring A reference of the PayPal transaction visible to customer which is mapped to PayPal’s invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
- payment_method_options.
paypal. risk_ correlation_ idstring The risk correlation ID for an on-session payment using a saved PayPal payment method.
- payment_method_options.
paypal. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
pixobject If this is a
pix
PaymentMethod, this sub-hash contains details about the Pix payment method options.- payment_method_options.
pix. amount_ includes_ iofenum Determines if the amount includes the IOF tax. Defaults to
never
.Possible enum valuesalways
The IOF tax is included in the amount.
never
The IOF tax is not included in the amount.
- payment_method_options.
pix. expires_ after_ secondsinteger The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
- payment_method_options.
pix. expires_ attimestamp The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.
- payment_method_options.
pix. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
promptpayobject If this is a
promptpay
PaymentMethod, this sub-hash contains details about the PromptPay payment method options.- payment_method_options.
promptpay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
revolut_ payobject If this is a
revolut_
PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.pay - payment_method_options.
revolut_pay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method - payment_method_options.
revolut_pay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
samsung_ payobject If this is a
samsung_
PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options.pay - payment_method_options.
samsung_pay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method
- payment_method_options.
satispayobject If this is a
satispay
PaymentMethod, this sub-hash contains details about the Satispay payment method options.- payment_method_options.
satispay. capture_ methodenum Controls when the funds are captured from the customer’s account.
If provided, this parameter overrides the behavior of the top-level capture_method for this payment method type when finalizing the payment with this payment method type.
If
capture_
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.method Possible enum valuesmanual
Use
manual
if you intend to place the funds on hold and want to override the top-levelcapture_
value for this payment method.method
- payment_method_options.
sepa_ debitobject If this is a
sepa_
PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.debit - payment_method_options.
sepa_debit. mandate_ optionsobject Additional fields for Mandate creation
- payment_method_options.
sepa_debit. mandate_options. reference_ prefixstringPreview feature Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘STRIPE’.
- payment_method_options.
sepa_debit. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
sepa_debit. target_ datestring Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
- payment_method_options.
sofortobject If this is a
sofort
PaymentMethod, this sub-hash contains details about the SOFORT payment method options.- payment_method_options.
sofort. preferred_ languageenum Language shown to the payer on redirect.
Possible enum valuesde
German
en
English
es
Spanish
fr
French
it
Italian
nl
Dutch
pl
Polish
- payment_method_options.
sofort. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session
- payment_method_options.
swishobject If this is a
Swish
PaymentMethod, this sub-hash contains details about the Swish payment method options.- payment_method_options.
swish. referencestring A reference for this payment to be displayed in the Swish app.
- payment_method_options.
swish. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
twintobject If this is a
twint
PaymentMethod, this sub-hash contains details about the TWINT payment method options.- payment_method_options.
twint. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
us_ bank_ accountobject If this is a
us_
PaymentMethod, this sub-hash contains details about the US bank account payment method options.bank_ account - payment_method_options.
us_bank_account. financial_ connectionsobject Additional fields for Financial Connections Session creation
- payment_method_options.
us_bank_account. financial_connections. filtersobject Provide filters for the linked accounts that the customer can select for the payment method.
- payment_method_options.
us_bank_account. financial_connections. filters. account_ subcategoriesarray of strings The account subcategories to use to filter for selectable accounts. Valid subcategories are
checking
andsavings
.
- payment_method_options.
us_bank_account. financial_connections. permissionsarray of strings The list of permissions to request. If this parameter is passed, the
payment_
permission must be included. Valid permissions include:method balances
,ownership
,payment_
, andmethod transactions
. - payment_method_options.
us_bank_account. financial_connections. prefetcharray of enums List of data features that you would like to retrieve upon account creation.
Possible enum valuesbalances
Requests to prefetch balance data on accounts collected in this session.
ownership
Requests to prefetch ownership data on accounts collected in this session.
transactions
Requests to prefetch transaction data on accounts collected in this session.
- payment_method_options.
us_bank_account. financial_connections. return_ urlstring For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
- payment_method_options.
us_bank_account. mandate_ optionsobject Additional fields for Mandate creation
- payment_method_options.
us_bank_account. mandate_options. collection_ methodenum The method used to collect offline mandate customer acceptance.
Possible enum valuespaper
Mandate customer acceptance was collected using a paper document
- payment_method_options.
us_bank_account. networksobject Additional fields for network related functions
- payment_method_options.
us_bank_account. networks. requestedarray of enums Triggers validations to run across the selected networks
Possible enum valuesach
us_
domestic_ wire
- payment_method_options.
us_bank_account. preferred_ settlement_ speedenum Preferred transaction settlement speed
- payment_method_options.
us_bank_account. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage off_
session Use
off_
if your customer may or may not be present in your checkout flow.session on_
session Use
on_
if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_method_options.
us_bank_account. target_ datestring Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
- payment_method_options.
us_bank_account. verification_ methodenum Bank account verification method.
Possible enum valuesautomatic
Instant verification with fallback to microdeposits.
instant
Instant verification only.
microdeposits
Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.
- payment_method_options.
wechat_ payobject If this is a
wechat_
PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.pay - payment_method_options.
wechat_pay. app_ idstring The app ID registered with WeChat Pay. Only required when client is ios or android.
- payment_method_options.
wechat_pay. clientenum The client type that the end customer will pay from
Possible enum valuesandroid
The end customer will pay from an Android app
ios
The end customer will pay from an iOS app
web
The end customer will pay from web browser
- payment_method_options.
wechat_pay. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_method_options.
zipobject If this is a
zip
PaymentMethod, this sub-hash contains details about the Zip payment method options.- payment_method_options.
zip. setup_ future_ usageenum Indicates that you intend to make future payments with this PaymentIntent’s payment method.
If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.
If the payment method is
card_
and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.present When processing card payments, Stripe uses
setup_
to help you comply with regional legislation and network rules, such as SCA.future_ usage If you’ve already set
setup_
and you’re performing a request using a publishable key, you can only update the value fromfuture_ usage on_
tosession off_
.session Possible enum valuesnone
Use
none
if you do not intend to reuse this payment method and want to override the top-levelsetup_
value for this payment method.future_ usage
- payment_
method_ typesarray of stringssecret key only The list of payment method types (for example, a card) that this PaymentIntent can use. Use
automatic_
to manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.payment_ methods - radar_
optionsobjectsecret key only Options to configure Radar. Learn more about Radar Sessions.
- radar_options.
sessionstringsecret key only A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
- return_
urlstring The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.
- use_
stripe_ sdkboolean Set to
true
when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
Returns
Returns the resulting PaymentIntent after all possible transitions are applied.
{ "id": "pi_3MtweELkdIwHu7ix0Dt0gF2H", "object": "payment_intent", "amount": 2000, "amount_capturable": 0, "amount_details": { "tip": {} }, "amount_received": 2000, "application": null, "application_fee_amount": null, "automatic_payment_methods": { "enabled": true }, "canceled_at": null, "cancellation_reason": null, "capture_method": "automatic", "client_secret": "pi_3MtweELkdIwHu7ix0Dt0gF2H_secret_ALlpPMIZse0ac8YzPxkMkFgGC", "confirmation_method": "automatic", "created": 1680802258, "currency": "usd", "customer": null, "description": null, "last_payment_error": null, "latest_charge": "ch_3MtweELkdIwHu7ix05lnLAFd", "livemode": false, "metadata": {}, "next_action": null, "on_behalf_of": null, "payment_method": "pm_1MtweELkdIwHu7ixxrsejPtG", "payment_method_options": { "card": { "installments": null, "mandate_options": null, "network": null, "request_three_d_secure": "automatic" }, "link": { "persistent_token": null } }, "payment_method_types": [ "card", "link" ], "processing": null, "receipt_email": null, "review": null, "setup_future_usage": null, "shipping": null, "source": null, "statement_descriptor": null, "statement_descriptor_suffix": null, "status": "succeeded", "transfer_data": null, "transfer_group": null}