com.stripe.param

Class SetupIntentCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SetupIntentCreateParams

public class SetupIntentCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetupIntentCreateParams.Builder
static class	SetupIntentCreateParams.MandateData
static class	SetupIntentCreateParams.PaymentMethodOptions The user agent of the browser from which the Mandate was accepted by the customer.
static class	SetupIntentCreateParams.SingleUse We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
static class	SetupIntentCreateParams.Usage Add all map key/value pairs to `extraParams` map.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static SetupIntentCreateParams.Builder	builder()
java.lang.Boolean	getConfirm() Set to true to attempt to confirm this SetupIntent immediately.
java.lang.String	getCustomer() ID of the Customer this SetupIntent belongs to, if one exists.
java.lang.String	getDescription() An arbitrary string attached to the object.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
SetupIntentCreateParams.MandateData	getMandateData() This hash contains details about the Mandate to create.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.String	getOnBehalfOf() The Stripe account ID for which this SetupIntent is created.
java.lang.String	getPaymentMethod() ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
SetupIntentCreateParams.PaymentMethodOptions	getPaymentMethodOptions() Payment-method-specific configuration for this SetupIntent.
java.util.List<java.lang.String>	getPaymentMethodTypes() The list of payment method types (e.g.
java.lang.String	getReturnUrl() The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
SetupIntentCreateParams.SingleUse	getSingleUse() If this hash is populated, this SetupIntent will generate a single_use Mandate on success.
SetupIntentCreateParams.Usage	getUsage() Indicates how the payment method is intended to be used in the future.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SetupIntentCreateParams.Builder builder()

getConfirm

public java.lang.Boolean getConfirm()

Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If the payment method attached is a card, a return_url may be provided in case additional authentication is required.

getCustomer

public java.lang.String getCustomer()

ID of the Customer this SetupIntent belongs to, if one exists.

If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

getDescription

public java.lang.String getDescription()

An arbitrary string attached to the object. Often useful for displaying to users.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.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.

getMandateData

public SetupIntentCreateParams.MandateData getMandateData()

This hash contains details about the Mandate to create. This parameter can only be used with confirm=true.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

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.

getOnBehalfOf

public java.lang.String getOnBehalfOf()

The Stripe account ID for which this SetupIntent is created.

getPaymentMethod

public java.lang.String getPaymentMethod()

ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.

getPaymentMethodOptions

public SetupIntentCreateParams.PaymentMethodOptions getPaymentMethodOptions()

Payment-method-specific configuration for this SetupIntent.

getPaymentMethodTypes

public java.util.List<java.lang.String> getPaymentMethodTypes()

The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to ["card"].

getReturnUrl

public java.lang.String getReturnUrl()

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 can only be used with confirm=true.

getSingleUse

public SetupIntentCreateParams.SingleUse getSingleUse()

If this hash is populated, this SetupIntent will generate a single_use Mandate on success.

getUsage

public SetupIntentCreateParams.Usage getUsage()

Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to off_session.