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 and Description
Builder()

Method Summary

Modifier and Type	Method and 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 applied to the payment and transferred to the application owner's Stripe account.
SessionCreateParams.PaymentIntentData.Builder	setCaptureMethod(SessionCreateParams.PaymentIntentData.CaptureMethod captureMethod) Capture method of this PaymentIntent, one of `automatic` or `manual`.
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 this PaymentIntent's payment method.
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	setTransferData(SessionCreateParams.PaymentIntentData.TransferData transferData) The parameters used to automatically create a Transfer when the payment succeeds.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

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 applied to the payment and transferred to the application owner's Stripe account. To use an application fee, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/payment-intents/use-cases#connected-accounts).

setCaptureMethod

public SessionCreateParams.PaymentIntentData.Builder setCaptureMethod(SessionCreateParams.PaymentIntentData.CaptureMethod captureMethod)

Capture method of this PaymentIntent, one of `automatic` or `manual`.

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. See SessionCreateParams.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. See SessionCreateParams.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. See SessionCreateParams.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. See SessionCreateParams.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](/docs/payments/payment-intents/use-cases#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.

setSetupFutureUsage

public SessionCreateParams.PaymentIntentData.Builder setSetupFutureUsage(SessionCreateParams.PaymentIntentData.SetupFutureUsage setupFutureUsage)

Indicates that you intend to make future payments with this PaymentIntent's payment method.

If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.

Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. See [Saving card details after a payment](https://stripe.com/docs/payments/cards/saving-cards#saving-card-after-payment) to learn more.

Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.

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.

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](https://stripe.com/docs/payments/payment-intents/use-cases#connected-accounts).