Package com.stripe.param.checkout
Class SessionCreateParams.PaymentIntentData.Builder
- java.lang.Object
-
- com.stripe.param.checkout.SessionCreateParams.PaymentIntentData.Builder
-
- Enclosing class:
- SessionCreateParams.PaymentIntentData
public static class SessionCreateParams.PaymentIntentData.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SessionCreateParams.PaymentIntentData
build()
Finalize and obtain parameter instance from this builder.SessionCreateParams.PaymentIntentData.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.SessionCreateParams.PaymentIntentData.Builder
putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map.SessionCreateParams.PaymentIntentData.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.SessionCreateParams.PaymentIntentData.Builder
putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map.SessionCreateParams.PaymentIntentData.Builder
setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
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.Builder
setCaptureMethod(SessionCreateParams.PaymentIntentData.CaptureMethod captureMethod)
Controls when the funds will be captured from the customer's account.SessionCreateParams.PaymentIntentData.Builder
setDescription(java.lang.String description)
An arbitrary string attached to the object.SessionCreateParams.PaymentIntentData.Builder
setOnBehalfOf(java.lang.String onBehalfOf)
The Stripe account ID for which these funds are intended.SessionCreateParams.PaymentIntentData.Builder
setReceiptEmail(java.lang.String receiptEmail)
Email address that the receipt for the resulting payment will be sent to.SessionCreateParams.PaymentIntentData.Builder
setSetupFutureUsage(SessionCreateParams.PaymentIntentData.SetupFutureUsage setupFutureUsage)
Indicates that you intend to make future payments with the payment method collected by this Checkout Session.SessionCreateParams.PaymentIntentData.Builder
setShipping(SessionCreateParams.PaymentIntentData.Shipping shipping)
Shipping information for this payment.SessionCreateParams.PaymentIntentData.Builder
setStatementDescriptor(java.lang.String statementDescriptor)
Extra information about the payment.SessionCreateParams.PaymentIntentData.Builder
setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)
Provides information about the charge that customers see on their statements.SessionCreateParams.PaymentIntentData.Builder
setTransferData(SessionCreateParams.PaymentIntentData.TransferData transferData)
The parameters used to automatically create a Transfer when the payment succeeds.SessionCreateParams.PaymentIntentData.Builder
setTransferGroup(java.lang.String transferGroup)
A string that identifies the resulting payment as part of a group.
-
-
-
Method Detail
-
build
public SessionCreateParams.PaymentIntentData build()
Finalize and obtain parameter instance from this builder.
-
setApplicationFeeAmount
public SessionCreateParams.PaymentIntentData.Builder setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
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.
-
setCaptureMethod
public SessionCreateParams.PaymentIntentData.Builder setCaptureMethod(SessionCreateParams.PaymentIntentData.CaptureMethod captureMethod)
Controls when the funds will be captured from the customer's account.
-
setDescription
public SessionCreateParams.PaymentIntentData.Builder setDescription(java.lang.String description)
An arbitrary string attached to the object. Often useful for displaying to users.
-
putExtraParam
public SessionCreateParams.PaymentIntentData.Builder putExtraParam(java.lang.String key, java.lang.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. SeeSessionCreateParams.PaymentIntentData.extraParams
for the field documentation.
-
putAllExtraParam
public SessionCreateParams.PaymentIntentData.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.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. SeeSessionCreateParams.PaymentIntentData.extraParams
for the field documentation.
-
putMetadata
public SessionCreateParams.PaymentIntentData.Builder putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSessionCreateParams.PaymentIntentData.metadata
for the field documentation.
-
putAllMetadata
public SessionCreateParams.PaymentIntentData.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSessionCreateParams.PaymentIntentData.metadata
for the field documentation.
-
setOnBehalfOf
public SessionCreateParams.PaymentIntentData.Builder setOnBehalfOf(java.lang.String onBehalfOf)
The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.
-
setReceiptEmail
public SessionCreateParams.PaymentIntentData.Builder setReceiptEmail(java.lang.String receiptEmail)
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.
-
setSetupFutureUsage
public SessionCreateParams.PaymentIntentData.Builder setSetupFutureUsage(SessionCreateParams.PaymentIntentData.SetupFutureUsage setupFutureUsage)
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.
-
setShipping
public SessionCreateParams.PaymentIntentData.Builder setShipping(SessionCreateParams.PaymentIntentData.Shipping shipping)
Shipping information for this payment.
-
setStatementDescriptor
public SessionCreateParams.PaymentIntentData.Builder setStatementDescriptor(java.lang.String statementDescriptor)
Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.
-
setStatementDescriptorSuffix
public SessionCreateParams.PaymentIntentData.Builder setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)
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.
-
setTransferData
public SessionCreateParams.PaymentIntentData.Builder setTransferData(SessionCreateParams.PaymentIntentData.TransferData transferData)
The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.
-
setTransferGroup
public SessionCreateParams.PaymentIntentData.Builder setTransferGroup(java.lang.String transferGroup)
A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
-
-