PaymentSheetAmountSelection

data class PaymentSheetAmountSelection(val purchaseIntentId: String? = null, val orderId: String? = null, val lineItemId: String? = null, val merchantName: String, val productName: String, val productAbout: String? = null, val currency: String, val minimum: Long, val maximum: Long? = null, val suggestions: List<PaymentSheetAmountSelection.Suggestion> = emptyList(), val expiresAt: Instant? = null)(source)

Client-safe amount policy for creating or changing a customer-selected checkout.

Suggested amounts are conveniences rather than an allow-list. The payer may submit any value inside minimum, maximum, and Checkout remains authoritative. purchaseIntentId is present while creating an Order from a Buy link; orderId and lineItemId are present while changing a customer-selected line on a still-pristine existing Order.

Constructors

Link copied to clipboard
constructor(purchaseIntentId: String? = null, orderId: String? = null, lineItemId: String? = null, merchantName: String, productName: String, productAbout: String? = null, currency: String, minimum: Long, maximum: Long? = null, suggestions: List<PaymentSheetAmountSelection.Suggestion> = emptyList(), expiresAt: Instant? = null)

Types

Link copied to clipboard
data class Suggestion(val id: String, val value: Long, val recommended: Boolean = false)

One convenient amount proposed by the merchant.

Properties

Link copied to clipboard

ISO 4217 currency code shared by the range and suggested amounts.

Link copied to clipboard

Time after which this policy must be fetched again before it is submitted.

Link copied to clipboard

Public identifier of the customer-selected line item being repriced.

Link copied to clipboard

Optional largest amount, in minor units, that Checkout will accept.

Link copied to clipboard

Merchant name shown alongside the amount-selection experience.

Link copied to clipboard

Smallest amount, in minor units, that Checkout will accept.

Link copied to clipboard

Public Order identifier when the payer is repricing an existing line item.

Link copied to clipboard

Optional product description supplied by the merchant.

Link copied to clipboard

Product name that gives the payer context for the amount they choose.

Link copied to clipboard

Public Buy link identifier when Checkout must create the Order.

Link copied to clipboard

Convenient merchant-provided amounts; payers may still enter any valid amount.