Package com.stripe.param

Class PaymentIntentUpdateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PaymentIntentUpdateParams
public class PaymentIntentUpdateParams extends ApiRequestParams

  • Method Details

    • builder

      public static PaymentIntentUpdateParams.Builder builder()

    • getAmount

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

    • getCaptureMethod

      public PaymentIntentUpdateParams.CaptureMethod getCaptureMethod()
      Controls when the funds will be captured from the customer's account.

    • getCurrency

      public Object getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getCustomer

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

    • getDescription

      public Object getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,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 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 to metadata.

    • getPaymentMethod

      public Object getPaymentMethod()
      ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.

    • getPaymentMethodConfiguration

      public Object getPaymentMethodConfiguration()
      The ID of the payment method configuration to use with 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 List<String> getPaymentMethodTypes()
      The list of payment method types (for example, card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard.

    • getReceiptEmail

      public Object getReceiptEmail()
      Email address that the receipt for the resulting payment will be sent to. If receipt_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.

      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.

      If you've already set setup_future_usage and you're performing a request using a publishable key, you can only update the value from on_session to off_session.

    • getShipping

      public Object getShipping()
      Shipping information for this PaymentIntent.

    • getStatementDescriptor

      public Object getStatementDescriptor()
      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.

    • getStatementDescriptorSuffix

      public Object getStatementDescriptorSuffix()
      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.

    • getTransferData

      public PaymentIntentUpdateParams.TransferData getTransferData()
      Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the use case for connected accounts.

    • getTransferGroup

      public Object getTransferGroup()
      A string that identifies the resulting payment as part of a group. You can only provide transfer_group if it hasn't been set. Learn more about the use case for connected accounts.