Package com.stripe.param

Class PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder

java.lang.Object

com.stripe.param.PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder

Enclosing class:

PaymentIntentConfirmParams.PaymentMethodOptions.Card

public static class PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentIntentConfirmParams.PaymentMethodOptions.Card	build()	Finalize and obtain parameter instance from this builder.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setCaptureMethod(EmptyParam captureMethod)	Controls when the funds will be captured from the customer's account.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setCaptureMethod(PaymentIntentConfirmParams.PaymentMethodOptions.Card.CaptureMethod captureMethod)	Controls when the funds will be captured from the customer's account.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setCvcToken(String cvcToken)	A single-use cvc_update Token that represents a card CVC value.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setInstallments(PaymentIntentConfirmParams.PaymentMethodOptions.Card.Installments installments)	Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setMandateOptions(PaymentIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions mandateOptions)	Configuration options for setting up an eMandate for cards issued in India.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setMoto(Boolean moto)	When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setNetwork(PaymentIntentConfirmParams.PaymentMethodOptions.Card.Network network)	Selected network to process this PaymentIntent on.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setRequestExtendedAuthorization(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestExtendedAuthorization requestExtendedAuthorization)	Request ability to capture beyond the standard authorization validity window for this PaymentIntent.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setRequestIncrementalAuthorization(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestIncrementalAuthorization requestIncrementalAuthorization)	Request ability to increment the authorization for this PaymentIntent.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setRequestMulticapture(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestMulticapture requestMulticapture)	Request ability to make multiple captures for this PaymentIntent.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setRequestOvercapture(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestOvercapture requestOvercapture)	Request ability to overcapture for this PaymentIntent.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setRequestThreeDSecure(PaymentIntentConfirmParams.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.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setRequireCvcRecollection(Boolean requireCvcRecollection)	When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setSetupFutureUsage(EmptyParam setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setSetupFutureUsage(PaymentIntentConfirmParams.PaymentMethodOptions.Card.SetupFutureUsage setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setStatementDescriptorSuffixKana(EmptyParam statementDescriptorSuffixKana)	Provides information about a card payment that customers see on their statements.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setStatementDescriptorSuffixKana(String statementDescriptorSuffixKana)	Provides information about a card payment that customers see on their statements.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setStatementDescriptorSuffixKanji(EmptyParam statementDescriptorSuffixKanji)	Provides information about a card payment that customers see on their statements.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setStatementDescriptorSuffixKanji(String statementDescriptorSuffixKanji)	Provides information about a card payment that customers see on their statements.
PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder	setThreeDSecure(PaymentIntentConfirmParams.PaymentMethodOptions.Card.ThreeDSecure threeDSecure)	If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public PaymentIntentConfirmParams.PaymentMethodOptions.Card build()

Finalize and obtain parameter instance from this builder.

setCaptureMethod

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setCaptureMethod(PaymentIntentConfirmParams.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 behavior of 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 PaymentIntentConfirmParams.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 behavior of 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

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setCvcToken(String cvcToken)

A single-use cvc_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 PaymentIntentConfirmParams.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. See PaymentIntentConfirmParams.PaymentMethodOptions.Card.extraParams for the field documentation.

putAllExtraParam

public PaymentIntentConfirmParams.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. See PaymentIntentConfirmParams.PaymentMethodOptions.Card.extraParams for the field documentation.

setInstallments

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setInstallments(PaymentIntentConfirmParams.PaymentMethodOptions.Card.Installments installments)

Installment configuration for payments attempted on this PaymentIntent (Mexico Only).

For more information, see the installments integration guide.

setMandateOptions

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setMandateOptions(PaymentIntentConfirmParams.PaymentMethodOptions.Card.MandateOptions mandateOptions)

Configuration options for setting up an eMandate for cards issued in India.

setMoto

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setMoto(Boolean moto)

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 PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setNetwork(PaymentIntentConfirmParams.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.

setRequestExtendedAuthorization

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setRequestExtendedAuthorization(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestExtendedAuthorization requestExtendedAuthorization)

Request ability to capture beyond the standard authorization validity window for this PaymentIntent.

setRequestIncrementalAuthorization

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setRequestIncrementalAuthorization(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestIncrementalAuthorization requestIncrementalAuthorization)

Request ability to increment the authorization for this PaymentIntent.

setRequestMulticapture

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setRequestMulticapture(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestMulticapture requestMulticapture)

Request ability to make multiple captures for this PaymentIntent.

setRequestOvercapture

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setRequestOvercapture(PaymentIntentConfirmParams.PaymentMethodOptions.Card.RequestOvercapture requestOvercapture)

Request ability to overcapture for this PaymentIntent.

setRequestThreeDSecure

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setRequestThreeDSecure(PaymentIntentConfirmParams.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. 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.

setRequireCvcRecollection

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setRequireCvcRecollection(Boolean requireCvcRecollection)

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).

setSetupFutureUsage

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setSetupFutureUsage(PaymentIntentConfirmParams.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 from on_session to off_session.

setSetupFutureUsage

public PaymentIntentConfirmParams.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 from on_session to off_session.

setStatementDescriptorSuffixKana

public PaymentIntentConfirmParams.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 PaymentIntentConfirmParams.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 PaymentIntentConfirmParams.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 PaymentIntentConfirmParams.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.

setThreeDSecure

public PaymentIntentConfirmParams.PaymentMethodOptions.Card.Builder setThreeDSecure(PaymentIntentConfirmParams.PaymentMethodOptions.Card.ThreeDSecure threeDSecure)

If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.