Class PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder
- Enclosing class:
- PaymentIntentUpdateParams.PaymentMethodOptions.Card
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.setCaptureMethod
(EmptyParam captureMethod) Controls when the funds will be captured from the customer's account.Controls when the funds will be captured from the customer's account.setCvcToken
(EmptyParam cvcToken) A single-usecvc_update
Token that represents a card CVC value.setCvcToken
(String cvcToken) A single-usecvc_update
Token that represents a card CVC value.Installment configuration for payments attempted on this PaymentIntent (Mexico Only).setMandateOptions
(PaymentIntentUpdateParams.PaymentMethodOptions.Card.MandateOptions mandateOptions) Configuration options for setting up an eMandate for cards issued in India.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.setRequestThreeDSecure
(PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestThreeDSecure requestThreeDSecure) We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.setSetupFutureUsage
(EmptyParam setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.setSetupFutureUsage
(PaymentIntentUpdateParams.PaymentMethodOptions.Card.SetupFutureUsage setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.setStatementDescriptorSuffixKana
(EmptyParam statementDescriptorSuffixKana) Provides information about a card payment that customers see on their statements.setStatementDescriptorSuffixKana
(String statementDescriptorSuffixKana) Provides information about a card payment that customers see on their statements.setStatementDescriptorSuffixKanji
(EmptyParam statementDescriptorSuffixKanji) Provides information about a card payment that customers see on their statements.setStatementDescriptorSuffixKanji
(String statementDescriptorSuffixKanji) Provides information about a card payment that customers see on their statements.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setCaptureMethod
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setCaptureMethod(PaymentIntentUpdateParams.PaymentMethodOptions.Card.CaptureMethod captureMethod) Controls when the funds will be captured from the customer's account.If provided, this parameter will override the top-level
capture_method
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 will unset the stored value for this payment method type. -
setCaptureMethod
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setCaptureMethod(EmptyParam captureMethod) Controls when the funds will be captured from the customer's account.If provided, this parameter will override the top-level
capture_method
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 will unset the stored value for this payment method type. -
setCvcToken
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. -
setCvcToken
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. -
putExtraParam
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder putExtraParam(String key, Object value) Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentIntentUpdateParams.PaymentMethodOptions.Card.extraParams
for the field documentation. -
putAllExtraParam
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder putAllExtraParam(Map<String, Object> map) Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentIntentUpdateParams.PaymentMethodOptions.Card.extraParams
for the field documentation. -
setInstallments
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setInstallments(PaymentIntentUpdateParams.PaymentMethodOptions.Card.Installments installments) Installment configuration for payments attempted on this PaymentIntent (Mexico Only).For more information, see the installments integration guide.
-
setMandateOptions
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setMandateOptions(PaymentIntentUpdateParams.PaymentMethodOptions.Card.MandateOptions mandateOptions) Configuration options for setting up an eMandate for cards issued in India. -
setMoto
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. -
setNetwork
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setNetwork(PaymentIntentUpdateParams.PaymentMethodOptions.Card.Network network) 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. -
setRequestThreeDSecure
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setRequestThreeDSecure(PaymentIntentUpdateParams.PaymentMethodOptions.Card.RequestThreeDSecure requestThreeDSecure) 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. Permitted values include:automatic
orany
. If not provided, defaults toautomatic
. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. -
setSetupFutureUsage
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setSetupFutureUsage(PaymentIntentUpdateParams.PaymentMethodOptions.Card.SetupFutureUsage setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usage
to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.If
setup_future_usage
is already set and you are performing a request using a publishable key, you may only update the value fromon_session
tooff_session
. -
setSetupFutureUsage
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setSetupFutureUsage(EmptyParam setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usage
to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.If
setup_future_usage
is already set and you are performing a request using a publishable key, you may only update the value fromon_session
tooff_session
. -
setStatementDescriptorSuffixKana
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setStatementDescriptorSuffixKana(String statementDescriptorSuffixKana) 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. -
setStatementDescriptorSuffixKana
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setStatementDescriptorSuffixKana(EmptyParam statementDescriptorSuffixKana) 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. -
setStatementDescriptorSuffixKanji
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setStatementDescriptorSuffixKanji(String statementDescriptorSuffixKanji) 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. -
setStatementDescriptorSuffixKanji
public PaymentIntentUpdateParams.PaymentMethodOptions.Card.Builder setStatementDescriptorSuffixKanji(EmptyParam statementDescriptorSuffixKanji) 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.
-