CheckoutOrder

data class CheckoutOrder(val id: String, val status: CheckoutOrder.Status, val merchant: CheckoutOrder.Merchant, val amount: CheckoutOrder.Money, val expiresAt: Instant? = null, val lineItems: List<CheckoutOrder.LineItem> = emptyList(), val documents: CheckoutOrder.Documents = Documents())(source)

Client-safe Order snapshot carried by Checkout lifecycle events.

Constructors

Link copied to clipboard
constructor(id: String, status: CheckoutOrder.Status, merchant: CheckoutOrder.Merchant, amount: CheckoutOrder.Money, expiresAt: Instant? = null, lineItems: List<CheckoutOrder.LineItem> = emptyList(), documents: CheckoutOrder.Documents = Documents())

Types

Link copied to clipboard
data class Documents(val invoiceUrl: String? = null, val receiptUrl: String? = null)

Customer documents available after payment.

Link copied to clipboard
data class LineItem(val id: String, val name: String, val quantity: Int? = null, val total: CheckoutOrder.Money)

Item included in the client-safe Order summary.

Link copied to clipboard
data class Merchant(val displayName: String)

Merchant details safe to show to the payer.

Link copied to clipboard
data class Money(val value: Long, val currency: String)

Monetary amount in minor currency units.

Link copied to clipboard

Payment state represented by the snapshot.

Properties

Link copied to clipboard

Order total in minor currency units.

Link copied to clipboard

Customer documents available for the Order.

Link copied to clipboard

Time after which the Order can no longer be paid.

Link copied to clipboard
val id: String

Stable Order identifier.

Link copied to clipboard

Items included in the Order summary.

Link copied to clipboard

Merchant presentation details.

Link copied to clipboard

Current payment state observed by Checkout.