Class PaymentLinkCreateParams.PaymentIntentData
- Enclosing class:
- PaymentLinkCreateParams
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static enum
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Controls when the funds will be captured from the customer's account.An arbitrary string attached to the object.Map of extra parameters for custom features not available in this client library.Set of key-value pairs that will declaratively set metadata on Payment Intents generated from this payment link.Indicates that you intend to make future payments with the payment method collected by this Checkout Session.Text that appears on the customer's statement as the statement descriptor for a non-card charge.Provides information about a card charge.A string that identifies the resulting payment as part of a group.
-
Method Details
-
builder
-
getCaptureMethod
Controls when the funds will be captured from the customer's account. -
getDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
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
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
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
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. -
getTransferGroup
A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
-