Class PaymentLinkCreateParams.PaymentIntentData.Builder
- Enclosing class:
- PaymentLinkCreateParams.PaymentIntentData
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putAllMetadata
(Map<String, String> map) Add all map key/value pairs to `metadata` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.putMetadata
(String key, String value) Add a key/value pair to `metadata` map.Controls when the funds will be captured from the customer's account.setDescription
(String description) An arbitrary string attached to the object.Indicates that you intend to make future payments with the payment method collected by this Checkout Session.setStatementDescriptor
(String statementDescriptor) Extra information about the payment.setStatementDescriptorSuffix
(String statementDescriptorSuffix) Provides information about the charge that customers see on their statements.setTransferGroup
(String transferGroup) A string that identifies the resulting payment as part of a group.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setCaptureMethod
public PaymentLinkCreateParams.PaymentIntentData.Builder setCaptureMethod(PaymentLinkCreateParams.PaymentIntentData.CaptureMethod captureMethod) Controls when the funds will be captured from the customer's account. -
setDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
putExtraParam
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentLinkCreateParams.PaymentIntentData.extraParams
for the field documentation. -
putAllExtraParam
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentLinkCreateParams.PaymentIntentData.extraParams
for the field documentation. -
putMetadata
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentLinkCreateParams.PaymentIntentData.metadata
for the field documentation. -
putAllMetadata
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeePaymentLinkCreateParams.PaymentIntentData.metadata
for the field documentation. -
setSetupFutureUsage
public PaymentLinkCreateParams.PaymentIntentData.Builder setSetupFutureUsage(PaymentLinkCreateParams.PaymentIntentData.SetupFutureUsage setupFutureUsage) 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. -
setStatementDescriptor
public PaymentLinkCreateParams.PaymentIntentData.Builder setStatementDescriptor(String statementDescriptor) Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge. -
setStatementDescriptorSuffix
public PaymentLinkCreateParams.PaymentIntentData.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix) 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. -
setTransferGroup
A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
-