Builder

class Builder(merchantDisplayName: String)

Constructors

Link copied to clipboard
constructor(merchantDisplayName: String)

Functions

Link copied to clipboard

If true, allows payment methods that do not move money at the end of the checkout. Defaults to false.

If true, allows payment methods that require a shipping address, like Afterpay and Affirm. Defaults to false.

Link copied to clipboard

Describes the appearance of the embedded payment element.

Link copied to clipboard

Describes how billing details should be collected. All values default to automatic. If never is used for a required field for the Payment Method used during checkout, you must provide an appropriate value as part of defaultBillingDetails.

Link copied to clipboard
Link copied to clipboard

By default, the payment element will accept all supported cards by Stripe. You can specify card brands that should block or allow payments for by providing a list of those card brands. Note: This is only a client-side solution. Note: Card brand filtering is not currently supported in Link.

Link copied to clipboard

If set, the customer can select a previously saved payment method.

Link copied to clipboard

Configuration related to custom payment methods.

Link copied to clipboard

The billing information for the customer.

Link copied to clipboard

Controls whether the view displays mandate text at the bottom for payment methods that require it.

Link copied to clipboard

External payment methods to display.

Link copied to clipboard

The view can display payment methods like "Card" that, when tapped, open a sheet where customers enter their payment method details. The sheet has a button at the bottom. formSheetAction controls the action the button performs.

Link copied to clipboard

Configuration related to the Stripe Customer making a payment.

Link copied to clipboard
Link copied to clipboard

By default, Stripe will use a dynamic ordering that optimizes payment method display for the customer. You can override the default order in which payment methods are displayed with a list of payment method types.

Link copied to clipboard

A list of preferred networks that should be used to process payments made with a co-branded card if your user hasn't selected a network themselves.

Link copied to clipboard

The label to use for the primary button.

Link copied to clipboard

The shipping information for the customer. If set, form fields will be pre populated with the values provided. This is used to display a "Billing address is same as shipping" checkbox if defaultBillingDetails is not provided. If name and line1 are populated, it's also attached to the PaymentIntent during payment.

Link copied to clipboard

A map for specifying when legal agreements are displayed for each payment method type. If the payment method is not specified in the list, the TermsDisplay value will default to automatic.