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 Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SessionCreateParams.PaymentIntentData	build()	Finalize and obtain parameter instance from this builder.
SessionCreateParams.PaymentIntentData.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
SessionCreateParams.PaymentIntentData.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
SessionCreateParams.PaymentIntentData.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
SessionCreateParams.PaymentIntentData.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
SessionCreateParams.PaymentIntentData.Builder	setApplicationFeeAmount(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(String description)	An arbitrary string attached to the object.
SessionCreateParams.PaymentIntentData.Builder	setOnBehalfOf(String onBehalfOf)	The Stripe account ID for which these funds are intended.
SessionCreateParams.PaymentIntentData.Builder	setReceiptEmail(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(String statementDescriptor)	Text that appears on the customer's statement as the statement descriptor for a non-card charge.
SessionCreateParams.PaymentIntentData.Builder	setStatementDescriptorSuffix(String statementDescriptorSuffix)	Provides information about a card charge.
SessionCreateParams.PaymentIntentData.Builder	setTransferData(SessionCreateParams.PaymentIntentData.TransferData transferData)	The parameters used to automatically create a Transfer when the payment succeeds.
SessionCreateParams.PaymentIntentData.Builder	setTransferGroup(String transferGroup)	A string that identifies the resulting payment as part of a group.

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 SessionCreateParams.PaymentIntentData build()

Finalize and obtain parameter instance from this builder.

setApplicationFeeAmount

public SessionCreateParams.PaymentIntentData.Builder setApplicationFeeAmount(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. 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(String description)

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

putExtraParam

public SessionCreateParams.PaymentIntentData.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 SessionCreateParams.PaymentIntentData.extraParams for the field documentation.

putAllExtraParam

public SessionCreateParams.PaymentIntentData.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 SessionCreateParams.PaymentIntentData.extraParams for the field documentation.

putMetadata

public SessionCreateParams.PaymentIntentData.Builder putMetadata(String key,
 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. See SessionCreateParams.PaymentIntentData.metadata for the field documentation.

putAllMetadata

public SessionCreateParams.PaymentIntentData.Builder putAllMetadata(Map<String,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. See SessionCreateParams.PaymentIntentData.metadata for the field documentation.

setOnBehalfOf

public SessionCreateParams.PaymentIntentData.Builder setOnBehalfOf(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(String receiptEmail)

Email address that the receipt for the resulting payment will be sent to. If receipt_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.

If a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.

If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

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(String statementDescriptor)

Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

setStatementDescriptorSuffix

public SessionCreateParams.PaymentIntentData.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix)

Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

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(String transferGroup)

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.