Package com.stripe.param

Class PaymentIntentUpdateParams.PaymentMethodOptions.Pix

java.lang.Object

com.stripe.param.PaymentIntentUpdateParams.PaymentMethodOptions.Pix

Enclosing class:

PaymentIntentUpdateParams.PaymentMethodOptions

public static class PaymentIntentUpdateParams.PaymentMethodOptions.Pix
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentIntentUpdateParams.PaymentMethodOptions.Pix.Builder
static enum	PaymentIntentUpdateParams.PaymentMethodOptions.Pix.SetupFutureUsage

Method Summary

Modifier and Type	Method	Description
static PaymentIntentUpdateParams.PaymentMethodOptions.Pix.Builder	builder()
Long	getExpiresAfterSeconds()	The number of seconds (between 10 and 1209600) after which Pix payment will expire.
Long	getExpiresAt()	The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future).
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
PaymentIntentUpdateParams.PaymentMethodOptions.Pix.SetupFutureUsage	getSetupFutureUsage()	Indicates that you intend to make future payments with this PaymentIntent's payment method.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static PaymentIntentUpdateParams.PaymentMethodOptions.Pix.Builder builder()

getExpiresAfterSeconds

public Long getExpiresAfterSeconds()

The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.

getExpiresAt

public Long getExpiresAt()

The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.

getExtraParams

public Map<String,Object> 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.

getSetupFutureUsage

public PaymentIntentUpdateParams.PaymentMethodOptions.Pix.SetupFutureUsage getSetupFutureUsage()

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.