Package com.stripe.param

Class PaymentLinkCreateParams.PaymentIntentData.Builder

java.lang.Object

com.stripe.param.PaymentLinkCreateParams.PaymentIntentData.Builder

Enclosing class:

PaymentLinkCreateParams.PaymentIntentData

public static class PaymentLinkCreateParams.PaymentIntentData.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentLinkCreateParams.PaymentIntentData	build()	Finalize and obtain parameter instance from this builder.
PaymentLinkCreateParams.PaymentIntentData.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentLinkCreateParams.PaymentIntentData.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PaymentLinkCreateParams.PaymentIntentData.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentLinkCreateParams.PaymentIntentData.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PaymentLinkCreateParams.PaymentIntentData.Builder	setCaptureMethod(PaymentLinkCreateParams.PaymentIntentData.CaptureMethod captureMethod)	Controls when the funds will be captured from the customer's account.
PaymentLinkCreateParams.PaymentIntentData.Builder	setDescription(String description)	An arbitrary string attached to the object.
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.
PaymentLinkCreateParams.PaymentIntentData.Builder	setStatementDescriptor(String statementDescriptor)	Text that appears on the customer's statement as the statement descriptor for a non-card charge.
PaymentLinkCreateParams.PaymentIntentData.Builder	setStatementDescriptorSuffix(String statementDescriptorSuffix)	Provides information about a card charge.
PaymentLinkCreateParams.PaymentIntentData.Builder	setTransferGroup(String transferGroup)	A string that identifies the resulting payment as part of a group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

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

public PaymentLinkCreateParams.PaymentIntentData.Builder setDescription(String description)

An arbitrary string attached to the object. Often useful for displaying to users.

putExtraParam

public PaymentLinkCreateParams.PaymentIntentData.Builder putExtraParam(String key,
 Object value)

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. See PaymentLinkCreateParams.PaymentIntentData.extraParams for the field documentation.

putAllExtraParam

public PaymentLinkCreateParams.PaymentIntentData.Builder putAllExtraParam(Map<String,Object> map)

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. See PaymentLinkCreateParams.PaymentIntentData.extraParams for the field documentation.

putMetadata

public PaymentLinkCreateParams.PaymentIntentData.Builder putMetadata(String key,
 String value)

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. See PaymentLinkCreateParams.PaymentIntentData.metadata for the field documentation.

putAllMetadata

public PaymentLinkCreateParams.PaymentIntentData.Builder putAllMetadata(Map<String,String> map)

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. See PaymentLinkCreateParams.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)

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.

setStatementDescriptorSuffix

public PaymentLinkCreateParams.PaymentIntentData.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix)

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.

setTransferGroup

public PaymentLinkCreateParams.PaymentIntentData.Builder setTransferGroup(String transferGroup)

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