Class PaymentLinkCreateParams.PaymentIntentData

Enclosing class:

public static class PaymentLinkCreateParams.PaymentIntentData extends Object
The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
  • Method Details

    • builder

    • getCaptureMethod

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

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.
    • 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 Map<String,String> getMetadata()
      Set of key-value pairs that will declaratively set metadata on Payment Intents generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
    • getSetupFutureUsage

      Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

      When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

      When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

      If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.

      If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

      When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

    • getStatementDescriptor

      public String getStatementDescriptor()
      Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.
    • getStatementDescriptorSuffix

      public String getStatementDescriptorSuffix()
      Provides information about the charge 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.
    • getTransferGroup

      public String getTransferGroup()
      A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.