Package com.stripe.param

Class PaymentIntentCreateParams.Builder

java.lang.Object

com.stripe.param.PaymentIntentCreateParams.Builder

Enclosing class:

PaymentIntentCreateParams

public static class PaymentIntentCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentIntentCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
PaymentIntentCreateParams.Builder	addAllPaymentMethodType(List<String> elements)	Add all elements to `paymentMethodTypes` list.
PaymentIntentCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
PaymentIntentCreateParams.Builder	addPaymentMethodType(String element)	Add an element to `paymentMethodTypes` list.
PaymentIntentCreateParams	build()	Finalize and obtain parameter instance from this builder.
PaymentIntentCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentIntentCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PaymentIntentCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentIntentCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PaymentIntentCreateParams.Builder	setAmount(Long amount)	Required. Amount intended to be collected by this PaymentIntent.
PaymentIntentCreateParams.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.
PaymentIntentCreateParams.Builder	setAutomaticPaymentMethods(PaymentIntentCreateParams.AutomaticPaymentMethods automaticPaymentMethods)	When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
PaymentIntentCreateParams.Builder	setCaptureMethod(PaymentIntentCreateParams.CaptureMethod captureMethod)	Controls when the funds will be captured from the customer's account.
PaymentIntentCreateParams.Builder	setConfirm(Boolean confirm)	Set to true to attempt to confirm this PaymentIntent immediately.
PaymentIntentCreateParams.Builder	setConfirmationMethod(PaymentIntentCreateParams.ConfirmationMethod confirmationMethod)	Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
PaymentIntentCreateParams.Builder	setConfirmationToken(String confirmationToken)	ID of the ConfirmationToken used to confirm this PaymentIntent.
PaymentIntentCreateParams.Builder	setCurrency(String currency)	Required. Three-letter ISO currency code, in lowercase.
PaymentIntentCreateParams.Builder	setCustomer(String customer)	ID of the Customer this PaymentIntent belongs to, if one exists.
PaymentIntentCreateParams.Builder	setDescription(String description)	An arbitrary string attached to the object.
PaymentIntentCreateParams.Builder	setErrorOnRequiresAction(Boolean errorOnRequiresAction)	Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action.
PaymentIntentCreateParams.Builder	setMandate(String mandate)	ID of the mandate that's used for this payment.
PaymentIntentCreateParams.Builder	setMandateData(EmptyParam mandateData)	This hash contains details about the Mandate to create.
PaymentIntentCreateParams.Builder	setMandateData(PaymentIntentCreateParams.MandateData mandateData)	This hash contains details about the Mandate to create.
PaymentIntentCreateParams.Builder	setOffSession(PaymentIntentCreateParams.OffSession offSession)	Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate.
PaymentIntentCreateParams.Builder	setOffSession(Boolean offSession)	Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate.
PaymentIntentCreateParams.Builder	setOnBehalfOf(String onBehalfOf)	The Stripe account ID that these funds are intended for.
PaymentIntentCreateParams.Builder	setPaymentMethod(String paymentMethod)	ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
PaymentIntentCreateParams.Builder	setPaymentMethodConfiguration(String paymentMethodConfiguration)	The ID of the payment method configuration to use with this PaymentIntent.
PaymentIntentCreateParams.Builder	setPaymentMethodData(PaymentIntentCreateParams.PaymentMethodData paymentMethodData)	If provided, this hash will be used to create a PaymentMethod.
PaymentIntentCreateParams.Builder	setPaymentMethodOptions(PaymentIntentCreateParams.PaymentMethodOptions paymentMethodOptions)	Payment method-specific configuration for this PaymentIntent.
PaymentIntentCreateParams.Builder	setRadarOptions(PaymentIntentCreateParams.RadarOptions radarOptions)	Options to configure Radar.
PaymentIntentCreateParams.Builder	setReceiptEmail(String receiptEmail)	Email address to send the receipt to.
PaymentIntentCreateParams.Builder	setReturnUrl(String returnUrl)	The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
PaymentIntentCreateParams.Builder	setSetupFutureUsage(PaymentIntentCreateParams.SetupFutureUsage setupFutureUsage)	Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentCreateParams.Builder	setShipping(PaymentIntentCreateParams.Shipping shipping)	Shipping information for this PaymentIntent.
PaymentIntentCreateParams.Builder	setStatementDescriptor(String statementDescriptor)	Text that appears on the customer's statement as the statement descriptor for a non-card charge.
PaymentIntentCreateParams.Builder	setStatementDescriptorSuffix(String statementDescriptorSuffix)	Provides information about a card charge.
PaymentIntentCreateParams.Builder	setTransferData(PaymentIntentCreateParams.TransferData transferData)	The parameters that you can use to automatically create a Transfer.
PaymentIntentCreateParams.Builder	setTransferGroup(String transferGroup)	A string that identifies the resulting payment as part of a group.
PaymentIntentCreateParams.Builder	setUseStripeSdk(Boolean useStripeSdk)	Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

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 PaymentIntentCreateParams build()

Finalize and obtain parameter instance from this builder.

setAmount

public PaymentIntentCreateParams.Builder setAmount(Long amount)

Required. Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

setApplicationFeeAmount

public PaymentIntentCreateParams.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.

setAutomaticPaymentMethods

public PaymentIntentCreateParams.Builder setAutomaticPaymentMethods(PaymentIntentCreateParams.AutomaticPaymentMethods automaticPaymentMethods)

When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.

setCaptureMethod

public PaymentIntentCreateParams.Builder setCaptureMethod(PaymentIntentCreateParams.CaptureMethod captureMethod)

Controls when the funds will be captured from the customer's account.

setConfirm

public PaymentIntentCreateParams.Builder setConfirm(Boolean confirm)

Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the Confirm API.

setConfirmationMethod

public PaymentIntentCreateParams.Builder setConfirmationMethod(PaymentIntentCreateParams.ConfirmationMethod confirmationMethod)

Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.

setConfirmationToken

public PaymentIntentCreateParams.Builder setConfirmationToken(String confirmationToken)

ID of the ConfirmationToken used to confirm this PaymentIntent.

If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

setCurrency

public PaymentIntentCreateParams.Builder setCurrency(String currency)

Required. Three-letter ISO currency code, in lowercase. Must be a supported currency.

setCustomer

public PaymentIntentCreateParams.Builder setCustomer(String customer)

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

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

setDescription

public PaymentIntentCreateParams.Builder setDescription(String description)

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

setErrorOnRequiresAction

public PaymentIntentCreateParams.Builder setErrorOnRequiresAction(Boolean errorOnRequiresAction)

Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true.

addExpand

public PaymentIntentCreateParams.Builder addExpand(String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentCreateParams.expand for the field documentation.

addAllExpand

public PaymentIntentCreateParams.Builder addAllExpand(List<String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentCreateParams.expand for the field documentation.

putExtraParam

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

putAllExtraParam

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

setMandate

public PaymentIntentCreateParams.Builder setMandate(String mandate)

ID of the mandate that's used for this payment. This parameter can only be used with confirm=true.

setMandateData

public PaymentIntentCreateParams.Builder setMandateData(PaymentIntentCreateParams.MandateData mandateData)

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

setMandateData

public PaymentIntentCreateParams.Builder setMandateData(EmptyParam mandateData)

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

putMetadata

public PaymentIntentCreateParams.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 PaymentIntentCreateParams.metadata for the field documentation.

putAllMetadata

public PaymentIntentCreateParams.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 PaymentIntentCreateParams.metadata for the field documentation.

setOffSession

public PaymentIntentCreateParams.Builder setOffSession(Boolean offSession)

Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.

setOffSession

public PaymentIntentCreateParams.Builder setOffSession(PaymentIntentCreateParams.OffSession offSession)

Set to true to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.

setOnBehalfOf

public PaymentIntentCreateParams.Builder setOnBehalfOf(String onBehalfOf)

The Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts.

setPaymentMethod

public PaymentIntentCreateParams.Builder setPaymentMethod(String paymentMethod)

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

If you don't provide the payment_method parameter or the source parameter with confirm=true, source automatically populates with customer.default_source to improve migration for users of the Charges API. We recommend that you explicitly provide the payment_method moving forward.

setPaymentMethodConfiguration

public PaymentIntentCreateParams.Builder setPaymentMethodConfiguration(String paymentMethodConfiguration)

The ID of the payment method configuration to use with this PaymentIntent.

setPaymentMethodData

public PaymentIntentCreateParams.Builder setPaymentMethodData(PaymentIntentCreateParams.PaymentMethodData paymentMethodData)

If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

setPaymentMethodOptions

public PaymentIntentCreateParams.Builder setPaymentMethodOptions(PaymentIntentCreateParams.PaymentMethodOptions paymentMethodOptions)

Payment method-specific configuration for this PaymentIntent.

addPaymentMethodType

public PaymentIntentCreateParams.Builder addPaymentMethodType(String element)

Add an element to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentCreateParams.paymentMethodTypes for the field documentation.

addAllPaymentMethodType

public PaymentIntentCreateParams.Builder addAllPaymentMethodType(List<String> elements)

Add all elements to `paymentMethodTypes` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentIntentCreateParams.paymentMethodTypes for the field documentation.

setRadarOptions

public PaymentIntentCreateParams.Builder setRadarOptions(PaymentIntentCreateParams.RadarOptions radarOptions)

Options to configure Radar. Learn more about Radar Sessions.

setReceiptEmail

public PaymentIntentCreateParams.Builder setReceiptEmail(String receiptEmail)

Email address to send the receipt to. If you specify receipt_email for a payment in live mode, you send a receipt regardless of your email settings.

setReturnUrl

public PaymentIntentCreateParams.Builder setReturnUrl(String returnUrl)

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.

setSetupFutureUsage

public PaymentIntentCreateParams.Builder setSetupFutureUsage(PaymentIntentCreateParams.SetupFutureUsage setupFutureUsage)

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

If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

setShipping

public PaymentIntentCreateParams.Builder setShipping(PaymentIntentCreateParams.Shipping shipping)

Shipping information for this PaymentIntent.

setStatementDescriptor

public PaymentIntentCreateParams.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 PaymentIntentCreateParams.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 PaymentIntentCreateParams.Builder setTransferData(PaymentIntentCreateParams.TransferData transferData)

The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts.

setTransferGroup

public PaymentIntentCreateParams.Builder setTransferGroup(String transferGroup)

A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.

setUseStripeSdk

public PaymentIntentCreateParams.Builder setUseStripeSdk(Boolean useStripeSdk)

Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.