Class PaymentIntentUpdateParams.PaymentMethodOptions.Card
- Enclosing class:
- PaymentIntentUpdateParams.PaymentMethodOptions
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
static class
Required. Type of installment plan, one offixed_count
.static enum
static enum
static enum
static enum
static enum
static enum
static enum
static class
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Controls when the funds are captured from the customer's account.A single-usecvc_update
Token that represents a card CVC value.Map of extra parameters for custom features not available in this client library.Installment configuration for payments attempted on this PaymentIntent (Mexico Only).Configuration options for setting up an eMandate for cards issued in India.getMoto()
When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA.Selected network to process this PaymentIntent on.Request ability to capture beyond the standard authorization validity window for this PaymentIntent.Request ability to increment the authorization for this PaymentIntent.Request ability to make multiple captures for this PaymentIntent.Request ability to overcapture for this PaymentIntent.We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e.Indicates that you intend to make future payments with this PaymentIntent's payment method.Provides information about a card payment that customers see on their statements.Provides information about a card payment that customers see on their statements.If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.
-
Method Details
-
builder
-
getCaptureMethod
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_method
is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. -
getCvcToken
A single-usecvc_update
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. -
getExtraParams
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance. -
getInstallments
Installment configuration for payments attempted on this PaymentIntent (Mexico Only).For more information, see the installments integration guide.
-
getMandateOptions
Configuration options for setting up an eMandate for cards issued in India. -
getMoto
When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. -
getNetwork
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. -
getRequestExtendedAuthorization
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestExtendedAuthorization getRequestExtendedAuthorization()Request ability to capture beyond the standard authorization validity window for this PaymentIntent. -
getRequestIncrementalAuthorization
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestIncrementalAuthorization getRequestIncrementalAuthorization()Request ability to increment the authorization for this PaymentIntent. -
getRequestMulticapture
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestMulticapture getRequestMulticapture()Request ability to make multiple captures for this PaymentIntent. -
getRequestOvercapture
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestOvercapture getRequestOvercapture()Request ability to overcapture for this PaymentIntent. -
getRequestThreeDSecure
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestThreeDSecure getRequestThreeDSecure()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 toautomatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. -
getRequireCvcRecollection
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). -
getSetupFutureUsage
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_present
and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.When processing card payments, Stripe uses
setup_future_usage
to help you comply with regional legislation and network rules, such as SCA.If you've already set
setup_future_usage
and you're performing a request using a publishable key, you can only update the value fromon_session
tooff_session
. -
getStatementDescriptorSuffixKana
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. -
getStatementDescriptorSuffixKanji
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. -
getThreeDSecure
If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.
-