com.stripe.param

Class PaymentIntentUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.PaymentIntentUpdateParams

public class PaymentIntentUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentIntentUpdateParams.Builder
static class	PaymentIntentUpdateParams.SetupFutureUsage Add all map key/value pairs to `extraParams` map.
static class	PaymentIntentUpdateParams.Shipping
static class	PaymentIntentUpdateParams.TransferData Add all map key/value pairs to `extraParams` map.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static PaymentIntentUpdateParams.Builder	builder()
java.lang.Long	getAmount() Amount intended to be collected by this PaymentIntent.
java.lang.Object	getApplicationFeeAmount() The amount of the application fee (if any) for the resulting payment.
java.lang.Object	getCurrency() Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
java.lang.Object	getCustomer() ID of the Customer this PaymentIntent belongs to, if one exists.
java.lang.Object	getDescription() An arbitrary string attached to the object.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.Object	getPaymentMethod() ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.
java.util.List<java.lang.String>	getPaymentMethodTypes() The list of payment method types (e.g.
java.lang.Object	getReceiptEmail() Email address that the receipt for the resulting payment will be sent to.
java.lang.Boolean	getSavePaymentMethod() 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.
ApiRequestParams.EnumParam	getSetupFutureUsage() Indicates that you intend to make future payments with this PaymentIntent's payment method.
java.lang.Object	getShipping() Shipping information for this PaymentIntent.
java.lang.Object	getSource() This is a legacy field that will be removed in the future.
java.lang.Object	getStatementDescriptor() For non-card charges, you can use this value as the complete description that appears on your customers’ statements.
java.lang.Object	getStatementDescriptorSuffix() Provides information about a card payment that customers see on their statements.
PaymentIntentUpdateParams.TransferData	getTransferData() The parameters used to automatically create a Transfer when the payment succeeds.
java.lang.Object	getTransferGroup() A string that identifies the resulting payment as part of a group.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static PaymentIntentUpdateParams.Builder builder()

getAmount

public java.lang.Long getAmount()

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

getApplicationFeeAmount

public java.lang.Object getApplicationFeeAmount()

The amount of the application fee (if any) for the resulting payment. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.

getCurrency

public java.lang.Object getCurrency()

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

getCustomer

public java.lang.Object getCustomer()

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

If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.

getDescription

public java.lang.Object getDescription()

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

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

getPaymentMethod

public java.lang.Object getPaymentMethod()

ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.

getPaymentMethodTypes

public java.util.List<java.lang.String> getPaymentMethodTypes()

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

getReceiptEmail

public java.lang.Object getReceiptEmail()

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

getSavePaymentMethod

public java.lang.Boolean getSavePaymentMethod()

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. Defaults to `false`.

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

_Note that saving a payment method using this parameter does not guarantee that the payment method can be charged._ To ensure that only payment methods which can be charged are saved to a customer, you can [manually save](https://stripe.com/docs/api/customers/create#create_customer-source) the payment method in response to the [`payment_intent.succeeded` webhook](https://stripe.com/docs/api/events/types#event_types-payment_intent.succeeded).

getSetupFutureUsage

public ApiRequestParams.EnumParam getSetupFutureUsage()

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.

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.

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`.

getShipping

public java.lang.Object getShipping()

Shipping information for this PaymentIntent.

getSource

public java.lang.Object getSource()

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](https://stripe.com/docs/payments/payment-methods#compatibility) objects.

getStatementDescriptor

public java.lang.Object getStatementDescriptor()

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.

getStatementDescriptorSuffix

public java.lang.Object getStatementDescriptorSuffix()

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.

getTransferData

public PaymentIntentUpdateParams.TransferData getTransferData()

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/connected-accounts).

getTransferGroup

public java.lang.Object getTransferGroup()

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](https://stripe.com/docs/payments/connected-accounts) for details.