Package com.stripe.param.checkout
Class SessionCreateParams.PaymentIntentData
- java.lang.Object
-
- com.stripe.param.checkout.SessionCreateParams.PaymentIntentData
-
- Enclosing class:
- SessionCreateParams
public static class SessionCreateParams.PaymentIntentData extends java.lang.Object
The number of intervals between subscription billings. For example,interval=month
andinterval_count=3
bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SessionCreateParams.PaymentIntentData.Builder
static class
SessionCreateParams.PaymentIntentData.CaptureMethod
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.PaymentIntentData.SetupFutureUsage
static class
SessionCreateParams.PaymentIntentData.Shipping
static class
SessionCreateParams.PaymentIntentData.TransferData
State, county, province, or region.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SessionCreateParams.PaymentIntentData.Builder
builder()
java.lang.Long
getApplicationFeeAmount()
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.SessionCreateParams.PaymentIntentData.CaptureMethod
getCaptureMethod()
Controls when the funds will be captured from the customer's account.java.lang.String
getDescription()
An arbitrary string attached to the object.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.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 these funds are intended.java.lang.String
getReceiptEmail()
Email address that the receipt for the resulting payment will be sent to.SessionCreateParams.PaymentIntentData.SetupFutureUsage
getSetupFutureUsage()
Indicates that you intend to make future payments with the payment method collected by this Checkout Session.SessionCreateParams.PaymentIntentData.Shipping
getShipping()
Shipping information for this payment.java.lang.String
getStatementDescriptor()
Extra information about the payment.java.lang.String
getStatementDescriptorSuffix()
Provides information about the charge that customers see on their statements.SessionCreateParams.PaymentIntentData.TransferData
getTransferData()
The parameters used to automatically create a Transfer when the payment succeeds.java.lang.String
getTransferGroup()
A string that identifies the resulting payment as part of a group.
-
-
-
Method Detail
-
builder
public static SessionCreateParams.PaymentIntentData.Builder builder()
-
getApplicationFeeAmount
public java.lang.Long getApplicationFeeAmount()
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. To use an application fee, the request must be made on behalf of another account, using theStripe-Account
header or an OAuth key. For more information, see the PaymentIntents use case for connected accounts.
-
getCaptureMethod
public SessionCreateParams.PaymentIntentData.CaptureMethod getCaptureMethod()
Controls when the funds will be captured from the customer's account.
-
getDescription
public java.lang.String getDescription()
An arbitrary string attached to the object. Often useful for displaying to users.
-
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.
-
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 tometadata
.
-
getOnBehalfOf
public java.lang.String getOnBehalfOf()
The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.
-
getReceiptEmail
public java.lang.String getReceiptEmail()
Email address that the receipt for the resulting payment will be sent to. Ifreceipt_email
is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
-
getSetupFutureUsage
public SessionCreateParams.PaymentIntentData.SetupFutureUsage getSetupFutureUsage()
Indicates that you intend to make future payments with the payment method collected by this Checkout Session.When setting this to
on_session
, Checkout will show a notice to the customer that their payment details will be saved.When setting this to
off_session
, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.For both values, Checkout will attach the payment method to either the provided Customer for the session, or a new Customer created by Checkout if one has not been provided.
When processing card payments, Checkout also uses
setup_future_usage
to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
-
getShipping
public SessionCreateParams.PaymentIntentData.Shipping getShipping()
Shipping information for this payment.
-
getStatementDescriptor
public java.lang.String getStatementDescriptor()
Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.
-
getStatementDescriptorSuffix
public java.lang.String getStatementDescriptorSuffix()
Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
-
getTransferData
public SessionCreateParams.PaymentIntentData.TransferData getTransferData()
The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.
-
getTransferGroup
public java.lang.String getTransferGroup()
A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
-
-