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 Description static class
PaymentIntentUpdateParams.Builder
static class
PaymentIntentUpdateParams.PaymentMethodData
static class
PaymentIntentUpdateParams.PaymentMethodOptions
static class
PaymentIntentUpdateParams.SetupFutureUsage
Add all map key/value pairs to `extraParams` map.static class
PaymentIntentUpdateParams.Shipping
Add all map key/value pairs to `extraParams` map.static class
PaymentIntentUpdateParams.TransferData
State, county, province, or region.-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.java.lang.Object
getCurrency()
Three-letter ISO currency code, 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.lang.Object
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 object) to attach to this PaymentIntent.PaymentIntentUpdateParams.PaymentMethodData
getPaymentMethodData()
If provided, this hash will be used to create a PaymentMethod.PaymentIntentUpdateParams.PaymentMethodOptions
getPaymentMethodOptions()
Payment-method-specific configuration for 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.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
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
-
-
-
-
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 (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).
-
getApplicationFeeAmount
public java.lang.Object getApplicationFeeAmount()
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.
-
getCurrency
public java.lang.Object getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getCustomer
public java.lang.Object getCustomer()
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.
-
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.lang.Object 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata
.
-
getPaymentMethod
public java.lang.Object getPaymentMethod()
ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
-
getPaymentMethodData
public PaymentIntentUpdateParams.PaymentMethodData getPaymentMethodData()
If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.
-
getPaymentMethodOptions
public PaymentIntentUpdateParams.PaymentMethodOptions getPaymentMethodOptions()
Payment-method-specific configuration for 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. Ifreceipt_email
is specified for a payment in live mode, a receipt will be sent regardless of your email settings.
-
getSetupFutureUsage
public ApiRequestParams.EnumParam getSetupFutureUsage()
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.
When processing card payments, Stripe also uses
setup_future_usage
to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.If
setup_future_usage
is already set and you are performing a request using a publishable key, you may only update the value fromon_session
tooff_session
.
-
getShipping
public java.lang.Object getShipping()
Shipping information for this PaymentIntent.
-
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.
-
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 for details.
-
-