com.stripe.param

Class PaymentIntentUpdateParams.Builder

java.lang.Object

com.stripe.param.PaymentIntentUpdateParams.Builder

Enclosing class:

PaymentIntentUpdateParams

public static class PaymentIntentUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PaymentIntentUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
PaymentIntentUpdateParams.Builder	addAllPaymentMethodType(java.util.List<java.lang.String> elements) Add all elements to `paymentMethodTypes` list.
PaymentIntentUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
PaymentIntentUpdateParams.Builder	addPaymentMethodType(java.lang.String element) Add an element to `paymentMethodTypes` list.
PaymentIntentUpdateParams	build() Finalize and obtain parameter instance from this builder.
PaymentIntentUpdateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
PaymentIntentUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
PaymentIntentUpdateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
PaymentIntentUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
PaymentIntentUpdateParams.Builder	setAmount(java.lang.Long amount) Amount intended to be collected by this PaymentIntent.
PaymentIntentUpdateParams.Builder	setApplicationFeeAmount(EmptyParam applicationFeeAmount) The amount of the application fee (if any) for the resulting payment.
PaymentIntentUpdateParams.Builder	setApplicationFeeAmount(java.lang.Long applicationFeeAmount) The amount of the application fee (if any) for the resulting payment.
PaymentIntentUpdateParams.Builder	setCurrency(EmptyParam currency) Three-letter ISO currency code, in lowercase.
PaymentIntentUpdateParams.Builder	setCurrency(java.lang.String currency) Three-letter ISO currency code, in lowercase.
PaymentIntentUpdateParams.Builder	setCustomer(EmptyParam customer) ID of the Customer this PaymentIntent belongs to, if one exists.
PaymentIntentUpdateParams.Builder	setCustomer(java.lang.String customer) ID of the Customer this PaymentIntent belongs to, if one exists.
PaymentIntentUpdateParams.Builder	setDescription(EmptyParam description) An arbitrary string attached to the object.
PaymentIntentUpdateParams.Builder	setDescription(java.lang.String description) An arbitrary string attached to the object.
PaymentIntentUpdateParams.Builder	setPaymentMethod(EmptyParam paymentMethod) ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
PaymentIntentUpdateParams.Builder	setPaymentMethod(java.lang.String paymentMethod) ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
PaymentIntentUpdateParams.Builder	setPaymentMethodOptions(PaymentIntentUpdateParams.PaymentMethodOptions paymentMethodOptions) Payment-method-specific configuration for this PaymentIntent.
PaymentIntentUpdateParams.Builder	setReceiptEmail(EmptyParam receiptEmail) Email address that the receipt for the resulting payment will be sent to.
PaymentIntentUpdateParams.Builder	setReceiptEmail(java.lang.String receiptEmail) Email address that the receipt for the resulting payment will be sent to.
PaymentIntentUpdateParams.Builder	setSavePaymentMethod(java.lang.Boolean savePaymentMethod) If the PaymentIntent has a payment_method and a customer or if you're attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer immediately.
PaymentIntentUpdateParams.Builder	setSetupFutureUsage(EmptyParam setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentUpdateParams.Builder	setSetupFutureUsage(PaymentIntentUpdateParams.SetupFutureUsage setupFutureUsage) Indicates that you intend to make future payments with this PaymentIntent's payment method.
PaymentIntentUpdateParams.Builder	setShipping(EmptyParam shipping) Shipping information for this PaymentIntent.
PaymentIntentUpdateParams.Builder	setShipping(PaymentIntentUpdateParams.Shipping shipping) Shipping information for this PaymentIntent.
PaymentIntentUpdateParams.Builder	setSource(EmptyParam source) This is a legacy field that will be removed in the future.
PaymentIntentUpdateParams.Builder	setSource(java.lang.String source) This is a legacy field that will be removed in the future.
PaymentIntentUpdateParams.Builder	setStatementDescriptor(EmptyParam statementDescriptor) For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
PaymentIntentUpdateParams.Builder	setStatementDescriptor(java.lang.String statementDescriptor) For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
PaymentIntentUpdateParams.Builder	setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix) Provides information about a card payment that customers see on their statements.
PaymentIntentUpdateParams.Builder	setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix) Provides information about a card payment that customers see on their statements.
PaymentIntentUpdateParams.Builder	setTransferData(PaymentIntentUpdateParams.TransferData transferData) The parameters used to automatically create a Transfer when the payment succeeds.
PaymentIntentUpdateParams.Builder	setTransferGroup(EmptyParam transferGroup) A string that identifies the resulting payment as part of a group.
PaymentIntentUpdateParams.Builder	setTransferGroup(java.lang.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 Detail

Builder

public Builder()

Method Detail

build

public PaymentIntentUpdateParams build()

Finalize and obtain parameter instance from this builder.

setAmount

public PaymentIntentUpdateParams.Builder setAmount(java.lang.Long amount)

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 PaymentIntentUpdateParams.Builder setApplicationFeeAmount(java.lang.Long applicationFeeAmount)

The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts for details.

setApplicationFeeAmount

public PaymentIntentUpdateParams.Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount)

The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts for details.

setCurrency

public PaymentIntentUpdateParams.Builder setCurrency(java.lang.String currency)

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

setCurrency

public PaymentIntentUpdateParams.Builder setCurrency(EmptyParam currency)

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

setCustomer

public PaymentIntentUpdateParams.Builder setCustomer(java.lang.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 present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

setCustomer

public PaymentIntentUpdateParams.Builder setCustomer(EmptyParam 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 present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

setDescription

public PaymentIntentUpdateParams.Builder setDescription(java.lang.String description)

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

setDescription

public PaymentIntentUpdateParams.Builder setDescription(EmptyParam description)

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

addExpand

public PaymentIntentUpdateParams.Builder addExpand(java.lang.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 PaymentIntentUpdateParams.expand for the field documentation.

addAllExpand

public PaymentIntentUpdateParams.Builder addAllExpand(java.util.List<java.lang.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 PaymentIntentUpdateParams.expand for the field documentation.

putExtraParam

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

putAllExtraParam

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

putMetadata

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

putAllMetadata

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

setPaymentMethod

public PaymentIntentUpdateParams.Builder setPaymentMethod(java.lang.String paymentMethod)

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

setPaymentMethod

public PaymentIntentUpdateParams.Builder setPaymentMethod(EmptyParam paymentMethod)

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

setPaymentMethodOptions

public PaymentIntentUpdateParams.Builder setPaymentMethodOptions(PaymentIntentUpdateParams.PaymentMethodOptions paymentMethodOptions)

Payment-method-specific configuration for this PaymentIntent.

addPaymentMethodType

public PaymentIntentUpdateParams.Builder addPaymentMethodType(java.lang.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 PaymentIntentUpdateParams.paymentMethodTypes for the field documentation.

addAllPaymentMethodType

public PaymentIntentUpdateParams.Builder addAllPaymentMethodType(java.util.List<java.lang.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 PaymentIntentUpdateParams.paymentMethodTypes for the field documentation.

setReceiptEmail

public PaymentIntentUpdateParams.Builder setReceiptEmail(java.lang.String receiptEmail)

Email address that the receipt for the resulting payment will be sent to.

setReceiptEmail

public PaymentIntentUpdateParams.Builder setReceiptEmail(EmptyParam receiptEmail)

Email address that the receipt for the resulting payment will be sent to.

setSavePaymentMethod

public PaymentIntentUpdateParams.Builder setSavePaymentMethod(java.lang.Boolean savePaymentMethod)

If the PaymentIntent has a payment_method and a customer or if you're attaching a payment method to the PaymentIntent in this request, you can pass save_payment_method=true to save the payment method to the customer immediately.

If the payment method is already saved to a customer, this parameter does nothing. If this type of payment method cannot be saved to a customer, the request will error.

Saving a payment method using this parameter is not recommended because it will save the payment method even if it cannot be charged (e.g. the user made a typo). To ensure that only payment methods which are likely to be chargeable are saved to a customer, use the (setup_future_usage)[#payment_intents/object#payment_intent_object-setup_future_usage] property, which saves the payment method after the PaymentIntent has been confirmed and all required actions by the customer are complete.

setSetupFutureUsage

public PaymentIntentUpdateParams.Builder setSetupFutureUsage(PaymentIntentUpdateParams.SetupFutureUsage setupFutureUsage)

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

Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

For more, learn to save card details during payment.

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, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.

If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.

setSetupFutureUsage

public PaymentIntentUpdateParams.Builder setSetupFutureUsage(EmptyParam setupFutureUsage)

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

Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

For more, learn to save card details during payment.

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, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.

If setup_future_usage is already set and you are performing a request using a publishable key, you may only update the value from on_session to off_session.

setShipping

public PaymentIntentUpdateParams.Builder setShipping(PaymentIntentUpdateParams.Shipping shipping)

Shipping information for this PaymentIntent.

setShipping

public PaymentIntentUpdateParams.Builder setShipping(EmptyParam shipping)

Shipping information for this PaymentIntent.

setSource

public PaymentIntentUpdateParams.Builder setSource(java.lang.String source)

This is a legacy field that will be removed in the future. It is the ID of the Source object to attach to this PaymentIntent. Please use the payment_method field instead, which also supports Cards and compatible Source objects.

setSource

public PaymentIntentUpdateParams.Builder setSource(EmptyParam source)

This is a legacy field that will be removed in the future. It is the ID of the Source object to attach to this PaymentIntent. Please use the payment_method field instead, which also supports Cards and compatible Source objects.

setStatementDescriptor

public PaymentIntentUpdateParams.Builder setStatementDescriptor(java.lang.String statementDescriptor)

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

setStatementDescriptor

public PaymentIntentUpdateParams.Builder setStatementDescriptor(EmptyParam statementDescriptor)

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

setStatementDescriptorSuffix

public PaymentIntentUpdateParams.Builder setStatementDescriptorSuffix(java.lang.String statementDescriptorSuffix)

Provides information about a card payment 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.

setStatementDescriptorSuffix

public PaymentIntentUpdateParams.Builder setStatementDescriptorSuffix(EmptyParam statementDescriptorSuffix)

Provides information about a card payment 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 PaymentIntentUpdateParams.Builder setTransferData(PaymentIntentUpdateParams.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 PaymentIntentUpdateParams.Builder setTransferGroup(java.lang.String transferGroup)

A string that identifies the resulting payment as part of a group. transfer_group may only be provided if it has not been set. See the PaymentIntents use case for connected accounts for details.

setTransferGroup

public PaymentIntentUpdateParams.Builder setTransferGroup(EmptyParam transferGroup)

A string that identifies the resulting payment as part of a group. transfer_group may only be provided if it has not been set. See the PaymentIntents use case for connected accounts for details.